added class const identifiers to outline
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / PHPeclipsePlugin.java
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
7
8  Contributors:
9  IBM Corporation - Initial implementation
10  Klaus Hartlage - www.eclipseproject.de
11  **********************************************************************/
12 package net.sourceforge.phpeclipse;
13
14 import java.io.File;
15 import java.util.ArrayList;
16 import java.util.Collection;
17 import java.util.HashMap;
18 import java.util.HashSet;
19 import java.util.Iterator;
20 import java.util.List;
21 import java.util.Set;
22
23 import net.sourceforge.phpdt.core.IBuffer;
24 import net.sourceforge.phpdt.core.IBufferFactory;
25 import net.sourceforge.phpdt.core.ICompilationUnit;
26 import net.sourceforge.phpdt.core.IJavaElement;
27 import net.sourceforge.phpdt.core.JavaCore;
28 import net.sourceforge.phpdt.core.WorkingCopyOwner;
29 import net.sourceforge.phpdt.externaltools.internal.model.ColorManager;
30 import net.sourceforge.phpdt.externaltools.internal.model.ExternalToolsPlugin;
31 import net.sourceforge.phpdt.externaltools.internal.model.VariableContextManager;
32 import net.sourceforge.phpdt.internal.core.BatchOperation;
33 import net.sourceforge.phpdt.internal.core.JavaModelManager;
34 import net.sourceforge.phpdt.internal.core.util.Util;
35 import net.sourceforge.phpdt.internal.ui.IJavaStatusConstants;
36 import net.sourceforge.phpdt.internal.ui.JavaElementAdapterFactory;
37 import net.sourceforge.phpdt.internal.ui.ResourceAdapterFactory;
38 import net.sourceforge.phpdt.internal.ui.preferences.MembersOrderPreferenceCache;
39 import net.sourceforge.phpdt.internal.ui.preferences.MockupPreferenceStore;
40 import net.sourceforge.phpdt.internal.ui.preferences.TemplatePreferencePage;
41 import net.sourceforge.phpdt.internal.ui.text.PreferencesAdapter;
42 import net.sourceforge.phpdt.internal.ui.text.folding.JavaFoldingStructureProviderRegistry;
43 import net.sourceforge.phpdt.internal.ui.text.java.hover.JavaEditorTextHoverDescriptor;
44 import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry;
45 import net.sourceforge.phpdt.internal.ui.viewsupport.ProblemMarkerManager;
46 import net.sourceforge.phpdt.ui.IContextMenuConstants;
47 import net.sourceforge.phpdt.ui.IWorkingCopyManager;
48 import net.sourceforge.phpdt.ui.PreferenceConstants;
49 import net.sourceforge.phpdt.ui.text.JavaTextTools;
50 import net.sourceforge.phpeclipse.builder.ExternalEditorInput;
51 import net.sourceforge.phpeclipse.builder.ExternalStorageDocumentProvider;
52 import net.sourceforge.phpeclipse.builder.FileStorage;
53 import net.sourceforge.phpeclipse.builder.IdentifierIndexManager;
54 import net.sourceforge.phpeclipse.phpeditor.CustomBufferFactory;
55 import net.sourceforge.phpeclipse.phpeditor.DocumentAdapter;
56 import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider;
57 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
58 import net.sourceforge.phpeclipse.phpeditor.WorkingCopyManager;
59 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
60
61 import org.eclipse.core.resources.IFile;
62 import org.eclipse.core.resources.IProject;
63 import org.eclipse.core.resources.IResource;
64 import org.eclipse.core.resources.IResourceChangeEvent;
65 import org.eclipse.core.resources.ISavedState;
66 import org.eclipse.core.resources.IWorkspace;
67 import org.eclipse.core.resources.IWorkspaceRunnable;
68 import org.eclipse.core.resources.ResourcesPlugin;
69 import org.eclipse.core.runtime.CoreException;
70 import org.eclipse.core.runtime.IAdapterManager;
71 import org.eclipse.core.runtime.IConfigurationElement;
72 import org.eclipse.core.runtime.IPath;
73 import org.eclipse.core.runtime.IPluginDescriptor;
74 import org.eclipse.core.runtime.IProgressMonitor;
75 import org.eclipse.core.runtime.IStatus;
76 import org.eclipse.core.runtime.Path;
77 import org.eclipse.core.runtime.Platform;
78 import org.eclipse.core.runtime.Status;
79 import org.eclipse.core.runtime.jobs.ISchedulingRule;
80 import org.eclipse.core.runtime.jobs.Job;
81 import org.eclipse.jface.action.GroupMarker;
82 import org.eclipse.jface.action.IMenuManager;
83 import org.eclipse.jface.action.Separator;
84 import org.eclipse.jface.preference.IPreferenceStore;
85 import org.eclipse.jface.preference.PreferenceConverter;
86 import org.eclipse.jface.resource.JFaceResources;
87 import org.eclipse.jface.text.BadLocationException;
88 import org.eclipse.jface.text.IDocument;
89 import org.eclipse.jface.util.IPropertyChangeListener;
90 import org.eclipse.jface.util.PropertyChangeEvent;
91 import org.eclipse.swt.graphics.RGB;
92 import org.eclipse.swt.widgets.Display;
93 import org.eclipse.swt.widgets.Shell;
94 import org.eclipse.ui.IEditorDescriptor;
95 import org.eclipse.ui.IEditorInput;
96 import org.eclipse.ui.IEditorPart;
97 import org.eclipse.ui.IEditorRegistry;
98 import org.eclipse.ui.IWorkbench;
99 import org.eclipse.ui.IWorkbenchPage;
100 import org.eclipse.ui.IWorkbenchWindow;
101 import org.eclipse.ui.PlatformUI;
102 import org.eclipse.ui.editors.text.EditorsUI;
103 import org.eclipse.ui.ide.IDE;
104 import org.eclipse.ui.plugin.AbstractUIPlugin;
105 import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
106 import org.eclipse.ui.texteditor.ChainedPreferenceStore;
107 import org.eclipse.ui.texteditor.ConfigurationElementSorter;
108 import org.eclipse.ui.texteditor.IDocumentProvider;
109 import org.eclipse.ui.texteditor.ITextEditor;
110 import org.eclipse.ui.texteditor.MarkerAnnotationPreferences;
111 import org.osgi.framework.BundleContext;
112
113 /**
114  * The main plugin class to be used in the desktop.
115  */
116 public class PHPeclipsePlugin extends AbstractUIPlugin implements
117     IPreferenceConstants {
118   /**
119    * The id of the PHP plugin (value <code>"net.sourceforge.phpeclipse"</code>).
120    */
121   public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$
122
123   /**
124    * id of builder - matches plugin.xml (concatenate pluginid.builderid)
125    */
126   public static final String BUILDER_PARSER_ID = PLUGIN_ID + ".parserbuilder";
127
128   //public static final String BUILDER_INDEX_ID = PLUGIN_ID + ".indexbuilder";
129   /** General debug flag */
130   public static final boolean DEBUG = false;
131
132   /**
133    * The maximum number of allowed proposals by category
134    */
135   public final static int MAX_PROPOSALS = 200;
136
137   private static ExternalToolsPlugin externalTools;
138
139   /**
140    * The Java virtual machine that we are running on.
141    */
142   private static int jvm;
143
144   /** MRJ 2.0 */
145   private static final int MRJ_2_0 = 0;
146
147   /** MRJ 2.1 or later */
148   private static final int MRJ_2_1 = 1;
149
150   /** Java on Mac OS X 10.0 (MRJ 3.0) */
151   private static final int MRJ_3_0 = 3;
152
153   /** MRJ 3.1 */
154   private static final int MRJ_3_1 = 4;
155
156   /** JVM constant for any other platform */
157   private static final int OTHER = -1;
158
159   // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID +
160   // ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
161   public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID
162       + ".ui.CodingActionSet"; //$NON-NLS-1$
163
164   public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
165
166   public static final String PHPPARSER_ORIGINAL = "net.sourceforge.phpdt.internal.compiler.parser.Parser";
167
168   public static final String PHPPARSER_NEW = "test.PHPParser";
169
170   /** Change this if you want to switch PHP Parser. */
171   public static final String PHPPARSER = PHPPARSER_ORIGINAL;
172
173   //The shared instance.
174   private static PHPeclipsePlugin plugin;
175
176   /** Windows 9x */
177   private static final int WINDOWS_9x = 6;
178
179   /** Windows NT */
180   private static final int WINDOWS_NT = 5;
181
182   private ImageDescriptorRegistry fImageDescriptorRegistry;
183
184   private HashMap fIndexManagerMap = new HashMap();
185
186   private IWorkingCopyManager fWorkingCopyManager;
187
188   private IBufferFactory fBufferFactory;
189
190   private PHPDocumentProvider fCompilationUnitDocumentProvider;
191
192   private JavaTextTools fJavaTextTools;
193
194   private ProblemMarkerManager fProblemMarkerManager;
195
196   private MembersOrderPreferenceCache fMembersOrderPreferenceCache;
197
198   private IFile fLastEditorFile = null;
199
200   private JavaEditorTextHoverDescriptor[] fJavaEditorTextHoverDescriptors;
201
202   private JavaElementAdapterFactory fJavaElementAdapterFactory;
203
204   //    private MarkerAdapterFactory fMarkerAdapterFactory;
205   //    private EditorInputAdapterFactory fEditorInputAdapterFactory;
206   private ResourceAdapterFactory fResourceAdapterFactory;
207
208   //    private LogicalPackageAdapterFactory fLogicalPackageAdapterFactory;
209   private IPropertyChangeListener fFontPropertyChangeListener;
210
211   /**
212    * Property change listener on this plugin's preference store.
213    * 
214    * @since 3.0
215    */
216   private IPropertyChangeListener fPropertyChangeListener;
217
218   /**
219    * The combined preference store.
220    * 
221    * @since 3.0
222    */
223   private IPreferenceStore fCombinedPreferenceStore;
224
225   /**
226    * The extension point registry for the
227    * <code>org.eclipse.jdt.ui.javaFoldingStructureProvider</code> extension
228    * point.
229    * 
230    * @since 3.0
231    */
232   private JavaFoldingStructureProviderRegistry fFoldingStructureProviderRegistry;
233
234   /**
235    * Mockup preference store for firing events and registering listeners on
236    * project setting changes. FIXME: Temporary solution.
237    * 
238    * @since 3.0
239    */
240   private MockupPreferenceStore fMockupPreferenceStore;
241
242   /**
243    * The constructor.
244    */
245   public PHPeclipsePlugin(IPluginDescriptor descriptor) {
246     super(descriptor);
247     plugin = this;
248     setJVM();
249     externalTools = new ExternalToolsPlugin();
250     //    try {
251     //      resourceBundle =
252     // ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
253     //    } catch (MissingResourceException x) {
254     //      resourceBundle = null;
255     //    }
256   }
257
258   //  /**
259   //   * Returns all Java editor text hovers contributed to the workbench.
260   //   *
261   //   * @return an array of JavaEditorTextHoverDescriptor
262   //   * @since 2.1
263   //   */
264   //  public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors()
265   // {
266   //    if (fJavaEditorTextHoverDescriptors == null)
267   //      fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor
268   //          .getContributedHovers();
269   //    return fJavaEditorTextHoverDescriptors;
270   //  }
271   /**
272    * Returns all Java editor text hovers contributed to the workbench.
273    * 
274    * @return an array of JavaEditorTextHoverDescriptor
275    * @since 2.1
276    */
277   public JavaEditorTextHoverDescriptor[] getJavaEditorTextHoverDescriptors() {
278     if (fJavaEditorTextHoverDescriptors == null) {
279       fJavaEditorTextHoverDescriptors = JavaEditorTextHoverDescriptor
280           .getContributedHovers();
281       ConfigurationElementSorter sorter = new ConfigurationElementSorter() {
282         /*
283          * @see org.eclipse.ui.texteditor.ConfigurationElementSorter#getConfigurationElement(java.lang.Object)
284          */
285         public IConfigurationElement getConfigurationElement(Object object) {
286           return ((JavaEditorTextHoverDescriptor) object)
287               .getConfigurationElement();
288         }
289       };
290       sorter.sort(fJavaEditorTextHoverDescriptors);
291
292       // The Problem hover has to be the first and the Annotation hover has to
293       // be the last one in the JDT UI's hover list
294       int length = fJavaEditorTextHoverDescriptors.length;
295       int first = -1;
296       int last = length - 1;
297       int problemHoverIndex = -1;
298       int annotationHoverIndex = -1;
299       for (int i = 0; i < length; i++) {
300         if (!fJavaEditorTextHoverDescriptors[i].getId().startsWith(PLUGIN_ID)) {
301           if (problemHoverIndex == -1 || annotationHoverIndex == -1)
302             continue;
303           else {
304             last = i - 1;
305             break;
306           }
307         }
308         if (first == -1)
309           first = i;
310
311         if (fJavaEditorTextHoverDescriptors[i].getId().equals(
312             "net.sourceforge.phpdt.ui.AnnotationHover")) { //$NON-NLS-1$
313           annotationHoverIndex = i;
314           continue;
315         }
316         if (fJavaEditorTextHoverDescriptors[i].getId().equals(
317             "net.sourceforge.phpdt.ui.ProblemHover")) { //$NON-NLS-1$
318           problemHoverIndex = i;
319           continue;
320         }
321       }
322
323       JavaEditorTextHoverDescriptor hoverDescriptor = null;
324
325       if (first > -1 && problemHoverIndex > -1 && problemHoverIndex != first) {
326         // move problem hover to beginning
327         hoverDescriptor = fJavaEditorTextHoverDescriptors[first];
328         fJavaEditorTextHoverDescriptors[first] = fJavaEditorTextHoverDescriptors[problemHoverIndex];
329         fJavaEditorTextHoverDescriptors[problemHoverIndex] = hoverDescriptor;
330
331         // update annotation hover index if needed
332         if (annotationHoverIndex == first)
333           annotationHoverIndex = problemHoverIndex;
334       }
335
336       if (annotationHoverIndex > -1 && annotationHoverIndex != last) {
337         // move annotation hover to end
338         hoverDescriptor = fJavaEditorTextHoverDescriptors[last];
339         fJavaEditorTextHoverDescriptors[last] = fJavaEditorTextHoverDescriptors[annotationHoverIndex];
340         fJavaEditorTextHoverDescriptors[annotationHoverIndex] = hoverDescriptor;
341       }
342
343       // Move Best Match hover to front
344       for (int i = 0; i < fJavaEditorTextHoverDescriptors.length - 1; i++) {
345         if (PreferenceConstants.ID_BESTMATCH_HOVER
346             .equals(fJavaEditorTextHoverDescriptors[i].getId())) {
347           hoverDescriptor = fJavaEditorTextHoverDescriptors[i];
348           for (int j = i; j > 0; j--)
349             fJavaEditorTextHoverDescriptors[j] = fJavaEditorTextHoverDescriptors[j - 1];
350           fJavaEditorTextHoverDescriptors[0] = hoverDescriptor;
351           break;
352         }
353
354       }
355     }
356
357     return fJavaEditorTextHoverDescriptors;
358   }
359
360   /**
361    * Resets the Java editor text hovers contributed to the workbench.
362    * <p>
363    * This will force a rebuild of the descriptors the next time a client asks
364    * for them.
365    * </p>
366    * 
367    * @return an array of JavaEditorTextHoverDescriptor
368    * @since 2.1
369    */
370   public void resetJavaEditorTextHoverDescriptors() {
371     fJavaEditorTextHoverDescriptors = null;
372   }
373
374   /**
375    * Creates the PHP plugin standard groups in a context menu.
376    */
377   public static void createStandardGroups(IMenuManager menu) {
378     if (!menu.isEmpty())
379       return;
380     menu.add(new Separator(IContextMenuConstants.GROUP_NEW));
381     menu.add(new GroupMarker(IContextMenuConstants.GROUP_GOTO));
382     menu.add(new Separator(IContextMenuConstants.GROUP_OPEN));
383     menu.add(new GroupMarker(IContextMenuConstants.GROUP_SHOW));
384     menu.add(new Separator(IContextMenuConstants.GROUP_REORGANIZE));
385     menu.add(new Separator(IContextMenuConstants.GROUP_GENERATE));
386     menu.add(new Separator(IContextMenuConstants.GROUP_SEARCH));
387     menu.add(new Separator(IContextMenuConstants.GROUP_BUILD));
388     menu.add(new Separator(IContextMenuConstants.GROUP_ADDITIONS));
389     menu.add(new Separator(IContextMenuConstants.GROUP_VIEWER_SETUP));
390     menu.add(new Separator(IContextMenuConstants.GROUP_PROPERTIES));
391   }
392
393   public static IWorkbenchPage getActivePage() {
394     return getDefault().internalGetActivePage();
395   }
396
397   public static Shell getActiveWorkbenchShell() {
398     return getActiveWorkbenchWindow().getShell();
399   }
400
401   /**
402    * Returns an array of all editors that have an unsaved content. If the
403    * identical content is presented in more than one editor, only one of those
404    * editor parts is part of the result.
405    * 
406    * @return an array of all dirty editor parts.
407    */
408   public static IEditorPart[] getDirtyEditors() {
409     Set inputs = new HashSet();
410     List result = new ArrayList(0);
411     IWorkbench workbench = getDefault().getWorkbench();
412     IWorkbenchWindow[] windows = workbench.getWorkbenchWindows();
413     for (int i = 0; i < windows.length; i++) {
414       IWorkbenchPage[] pages = windows[i].getPages();
415       for (int x = 0; x < pages.length; x++) {
416         IEditorPart[] editors = pages[x].getDirtyEditors();
417         for (int z = 0; z < editors.length; z++) {
418           IEditorPart ep = editors[z];
419           IEditorInput input = ep.getEditorInput();
420           if (!inputs.contains(input)) {
421             inputs.add(input);
422             result.add(ep);
423           }
424         }
425       }
426     }
427     return (IEditorPart[]) result.toArray(new IEditorPart[result.size()]);
428   }
429
430   public static IWorkbenchWindow getActiveWorkbenchWindow() {
431     return getDefault().getWorkbench().getActiveWorkbenchWindow();
432   }
433
434   /**
435    * Returns the shared instance.
436    */
437   public static PHPeclipsePlugin getDefault() {
438     return plugin;
439   }
440
441   public static ImageDescriptorRegistry getImageDescriptorRegistry() {
442     return getDefault().internalGetImageDescriptorRegistry();
443   }
444
445   static IPath getInstallLocation() {
446     return new Path(getDefault().getDescriptor().getInstallURL().getFile());
447   }
448
449   public static int getJVM() {
450     return jvm;
451   }
452
453   public static String getPluginId() {
454     return getDefault().getDescriptor().getUniqueIdentifier();
455   }
456
457   /**
458    * Returns the standard display to be used. The method first checks, if the
459    * thread calling this method has an associated display. If so, this display
460    * is returned. Otherwise the method returns the default display.
461    */
462   public static Display getStandardDisplay() {
463     Display display = Display.getCurrent();
464     if (display == null) {
465       display = Display.getDefault();
466     }
467     return display;
468   }
469
470   //  public static ExternalToolsPlugin getExternalTools() {
471   //    return externalTools;
472   //  }
473   /**
474    * Returns the workspace instance.
475    */
476   public static IWorkspace getWorkspace() {
477     return ResourcesPlugin.getWorkspace();
478   }
479
480   public static boolean isDebug() {
481     return getDefault().isDebugging();
482   }
483
484   //  public static void logErrorMessage(String message) {
485   //    log(new Status(IStatus.ERROR, getPluginId(),
486   // JavaStatusConstants.INTERNAL_ERROR, message, null));
487   //  }
488   //
489   //  public static void logErrorStatus(String message, IStatus status) {
490   //    if (status == null) {
491   //      logErrorMessage(message);
492   //      return;
493   //    }
494   //    MultiStatus multi= new MultiStatus(getPluginId(),
495   // JavaStatusConstants.INTERNAL_ERROR, message, null);
496   //    multi.add(status);
497   //    log(multi);
498   //  }
499   //
500   //  public static void log(Throwable e) {
501   //    log(new Status(IStatus.ERROR, getPluginId(),
502   // JavaStatusConstants.INTERNAL_ERROR,
503   // JavaUIMessages.getString("JavaPlugin.internal_error"), e)); //$NON-NLS-1$
504   //  }
505   public static void log(int severity, String message) {
506     Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null);
507     log(status);
508   }
509
510   public static void log(IStatus status) {
511     getDefault().getLog().log(status);
512   }
513
514   public static void log(Throwable e) {
515     log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR,
516         "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$
517   }
518
519   public static void logErrorMessage(String message) {
520     log(new Status(IStatus.ERROR, getPluginId(),
521         IJavaStatusConstants.INTERNAL_ERROR, message, null));
522   }
523
524   private static void setJVM() {
525     String osName = System.getProperty("os.name");
526     if (osName.startsWith("Mac OS")) {
527       String mrjVersion = System.getProperty("mrj.version");
528       String majorMRJVersion = mrjVersion.substring(0, 3);
529       jvm = OTHER;
530       try {
531         double version = Double.valueOf(majorMRJVersion).doubleValue();
532         if (version == 2) {
533           jvm = MRJ_2_0;
534         } else if (version >= 2.1 && version < 3) {
535           jvm = MRJ_2_1;
536         } else if (version == 3.0) {
537           jvm = MRJ_3_0;
538         } else if (version >= 3.1) {
539           jvm = MRJ_3_1;
540         }
541       } catch (NumberFormatException nfe) {
542       }
543     } else if (osName.startsWith("Windows")) {
544       if (osName.indexOf("9") != -1) {
545         jvm = WINDOWS_9x;
546       } else {
547         jvm = WINDOWS_NT;
548       }
549     }
550   }
551
552   // TODO: refactor this into a better method name !
553   public synchronized PHPDocumentProvider getCompilationUnitDocumentProvider() {
554     if (fCompilationUnitDocumentProvider == null)
555       fCompilationUnitDocumentProvider = new PHPDocumentProvider();
556     return fCompilationUnitDocumentProvider;
557   }
558
559   /**
560    * Get the identifier index manager for the given project
561    * 
562    * @param iProject
563    *          the current project
564    * @return
565    */
566   public IdentifierIndexManager getIndexManager(IProject iProject) {
567     String indexFilename = iProject.getLocation() + File.separator
568         + "project.index";
569     IdentifierIndexManager indexManager = (IdentifierIndexManager) fIndexManagerMap
570         .get(indexFilename);
571     if (indexManager == null) {
572       indexManager = new IdentifierIndexManager(indexFilename);
573       fIndexManagerMap.put(indexFilename, indexManager);
574     }
575     return indexManager;
576   }
577
578   public synchronized IWorkingCopyManager getWorkingCopyManager() {
579     if (fWorkingCopyManager == null) {
580       PHPDocumentProvider provider = getCompilationUnitDocumentProvider();
581       fWorkingCopyManager = new WorkingCopyManager(provider);
582     }
583     return fWorkingCopyManager;
584   }
585
586   public synchronized MembersOrderPreferenceCache getMemberOrderPreferenceCache() {
587     if (fMembersOrderPreferenceCache == null)
588       fMembersOrderPreferenceCache = new MembersOrderPreferenceCache();
589     return fMembersOrderPreferenceCache;
590   }
591
592   /**
593    * Returns the mockup preference store for firing events and registering
594    * listeners on project setting changes. Temporary solution.
595    */
596   public MockupPreferenceStore getMockupPreferenceStore() {
597     if (fMockupPreferenceStore == null)
598       fMockupPreferenceStore = new MockupPreferenceStore();
599
600     return fMockupPreferenceStore;
601   }
602
603   public synchronized ProblemMarkerManager getProblemMarkerManager() {
604     if (fProblemMarkerManager == null)
605       fProblemMarkerManager = new ProblemMarkerManager();
606     return fProblemMarkerManager;
607   }
608
609   public synchronized JavaTextTools getJavaTextTools() {
610     if (fJavaTextTools == null)
611       fJavaTextTools = new JavaTextTools(getPreferenceStore());
612     return fJavaTextTools;
613   }
614
615   public IFile getLastEditorFile() {
616     return fLastEditorFile;
617   }
618
619   /**
620    * Returns the string from the plugin's resource bundle, or 'key' if not
621    * found.
622    */
623   //  public static String getResourceString(String key) {
624   //    ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
625   //    try {
626   //      return bundle.getString(key);
627   //    } catch (MissingResourceException e) {
628   //      return key;
629   //    }
630   //  }
631   /**
632    * Returns the plugin's resource bundle,
633    */
634   //  public ResourceBundle getResourceBundle() {
635   //    return resourceBundle;
636   //  }
637   protected void initializeDefaultPreferences(IPreferenceStore store) {
638     // windows preferences:
639     store.setDefault(LOCALHOST_PREF, "http://localhost");
640     //    store.setDefault(SHOW_EXTERNAL_PREVIEW_PREF, "true");
641     store.setDefault(USE_EXTERNAL_BROWSER_PREF, "false");
642     store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
643     store.setDefault(PHP_OBFUSCATOR_DEFAULT, "c:\\temp");
644     store.setDefault(PHP_BOOKMARK_DEFAULT, "");
645
646     store.setDefault(PHP_AUTO_PREVIEW_DEFAULT, "true");
647     store.setDefault(PHP_BRING_TO_TOP_PREVIEW_DEFAULT, "true");
648
649     String windowsSystem = Platform.getWS();
650     if (jvm == WINDOWS_9x) {
651       store.setDefault(EXTERNAL_BROWSER_PREF,
652           "command.com /c start iexplore {0}");
653     } else if (windowsSystem.equals(Platform.WS_WIN32)) {
654       store.setDefault(EXTERNAL_BROWSER_PREF,
655           "rundll32 url.dll,FileProtocolHandler {0}");
656     } else if (windowsSystem.equals(Platform.WS_CARBON)) {
657       // TODO How do we start Safari on Mac OS X ?
658       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
659     } else {
660       store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp");
661       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
662     }
663     store.setDefault(DOCUMENTROOT_PREF, getWorkspace().getRoot().getLocation()
664         .toString());
665     //  if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) {
666     //  
667     if (windowsSystem.equals(Platform.WS_WIN32)) {
668       store.setDefault(PHP_RUN_PREF, "c:\\apache\\php\\php.exe");
669       store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
670       store.setDefault(MYSQL_RUN_PREF, "c:\\apache\\mysql\\bin\\mysqld-nt.exe");
671       store.setDefault(APACHE_RUN_PREF, "c:\\apache\\apache.exe");
672     } else {
673       store.setDefault(PHP_RUN_PREF, "/apache/php/php");
674       store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
675       store.setDefault(MYSQL_RUN_PREF, "/apache/mysql/bin/mysqld");
676       store.setDefault(APACHE_RUN_PREF, "/apache/apache");
677     }
678     store.setDefault(MYSQL_PREF, "--standalone");
679     store.setDefault(APACHE_START_PREF, "-c \"DocumentRoot \"{0}\"\"");
680     store.setDefault(APACHE_STOP_PREF, "-k shutdown");
681     store.setDefault(APACHE_RESTART_PREF, "-k restart");
682     store.setDefault(MYSQL_START_BACKGROUND, "true");
683     store.setDefault(APACHE_START_BACKGROUND, "true");
684     store.setDefault(APACHE_STOP_BACKGROUND, "true");
685     store.setDefault(APACHE_RESTART_BACKGROUND, "true");
686     store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
687     store.setDefault(PHP_INTERNAL_PARSER, "false");
688     store.setDefault(PHP_EXTERNAL_PARSER, "true");
689     //    store.setDefault(PHP_PARSE_ON_SAVE, "true");
690     // show line numbers:
691     //   store.setDefault(LINE_NUMBER_RULER, "false");
692     //    store.setDefault(FORMATTER_TAB_SIZE, "4");
693     // php syntax highlighting
694     store.setDefault(PHP_USERDEF_XMLFILE, "");
695     //assume there is none chooA
696     PreferenceConverter.setDefault(store, PHP_MULTILINE_COMMENT,
697         PHPColorProvider.MULTI_LINE_COMMENT);
698     PreferenceConverter.setDefault(store, PHP_SINGLELINE_COMMENT,
699         PHPColorProvider.SINGLE_LINE_COMMENT);
700     PreferenceConverter.setDefault(store, PHP_TAG, PHPColorProvider.TAG);
701     PreferenceConverter
702         .setDefault(store, PHP_KEYWORD, PHPColorProvider.KEYWORD);
703     PreferenceConverter.setDefault(store, PHP_VARIABLE,
704         PHPColorProvider.VARIABLE);
705     PreferenceConverter.setDefault(store, PHP_FUNCTIONNAME,
706         PHPColorProvider.FUNCTION_NAME);
707     PreferenceConverter.setDefault(store, PHP_CONSTANT,
708         PHPColorProvider.CONSTANT);
709     PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
710     PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING);
711     PreferenceConverter
712         .setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
713     PreferenceConverter.setDefault(store, PHPDOC_KEYWORD,
714         PHPColorProvider.PHPDOC_KEYWORD);
715     PreferenceConverter.setDefault(store, PHPDOC_TAG,
716         PHPColorProvider.PHPDOC_TAG);
717     PreferenceConverter.setDefault(store, PHPDOC_LINK,
718         PHPColorProvider.PHPDOC_LINK);
719     PreferenceConverter.setDefault(store, PHPDOC_DEFAULT,
720         PHPColorProvider.PHPDOC_DEFAULT);
721
722     PreferenceConverter.setDefault(store, EDITOR_PHP_KEYWORD_RETURN_COLOR,
723         new RGB(127, 0, 85));
724     store.setDefault(EDITOR_PHP_KEYWORD_RETURN_BOLD, true);
725     store.setDefault(EDITOR_PHP_KEYWORD_RETURN_ITALIC, false);
726
727     PreferenceConverter.setDefault(store, EDITOR_PHP_OPERATOR_COLOR, new RGB(0,
728         0, 0));
729     store.setDefault(EDITOR_PHP_OPERATOR_BOLD, false);
730     store.setDefault(EDITOR_PHP_OPERATOR_ITALIC, false);
731
732     //    PreferenceConverter.setDefault(
733     //      store,
734     //      PHP_EDITOR_BACKGROUND,
735     //      PHPColorProvider.BACKGROUND);
736     //    PreferenceConverter.setDefault(
737     //      store,
738     //      LINKED_POSITION_COLOR,
739     //      PHPColorProvider.LINKED_POSITION_COLOR);
740     //    PreferenceConverter.setDefault(
741     //      store,
742     //      LINE_NUMBER_COLOR,
743     //      PHPColorProvider.LINE_NUMBER_COLOR);
744     //    // set default PHPDoc colors:
745     //    PreferenceConverter.setDefault(
746     //      store,
747     //      PHPDOC_KEYWORD,
748     //      PHPColorProvider.PHPDOC_KEYWORD);
749     //    PreferenceConverter.setDefault(
750     //      store,
751     //      PHPDOC_LINK,
752     //      PHPColorProvider.PHPDOC_LINK);
753     //    PreferenceConverter.setDefault(
754     //      store,
755     //      PHPDOC_DEFAULT,
756     //      PHPColorProvider.PHPDOC_DEFAULT);
757     //    PreferenceConverter.setDefault(
758     //      store,
759     //      PHPDOC_TAG,
760     //      PHPColorProvider.PHPDOC_TAG);
761     //    store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
762     //    PreferenceConverter.setDefault(
763     //      store,
764     //      PREFERENCE_COLOR_BACKGROUND,
765     //      PHPColorProvider.BACKGROUND_COLOR);
766     //language stuff
767     //    store.setDefault(RESOURCE_BUNDLE, LANGUAGE_DEFAULT);
768     //    store.setDefault(RESOURCE_BUNDLE_EN_GB, "true");
769     //    store.setDefault(RESOURCE_BUNDLE_DE, "false");
770     //    store.setDefault(RESOURCE_BUNDLE_FR, "false");
771     //    store.setDefault(RESOURCE_BUNDLE_ES, "false");
772     TemplatePreferencePage.initDefaults(store);
773     //this will initialize the static fields in the syntaxrdr class
774     new PHPSyntaxRdr();
775     JavaCore.initializeDefaultPluginPreferences();
776     PreferenceConstants.initializeDefaultValues(store);
777     externalTools.initializeDefaultPreferences(store);
778     MarkerAnnotationPreferences.initializeDefaultValues(store);
779   }
780
781   private IWorkbenchPage internalGetActivePage() {
782     IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
783     if (window != null)
784       return window.getActivePage();
785     return null;
786   }
787
788   private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
789     if (fImageDescriptorRegistry == null)
790       fImageDescriptorRegistry = new ImageDescriptorRegistry();
791     return fImageDescriptorRegistry;
792   }
793
794   /**
795    * Open a file in the Workbench that may or may not exist in the workspace.
796    * Must be run on the UI thread.
797    * 
798    * @param filename
799    * @throws CoreException
800    */
801   public ITextEditor openFileInTextEditor(String filename) throws CoreException {
802     //  reject directories
803     if (new File(filename).isDirectory())
804       return null;
805     IWorkbench workbench = PlatformUI.getWorkbench();
806     IWorkbenchWindow window = workbench.getWorkbenchWindows()[0];
807     IWorkbenchPage page = window.getActivePage();
808     IPath path = new Path(filename);
809     // If the file exists in the workspace, open it
810     IFile file = getWorkspace().getRoot().getFileForLocation(path);
811     IEditorPart editor;
812     ITextEditor textEditor;
813     if (file != null && file.exists()) {
814       editor = IDE.openEditor(page, file, true);
815       textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
816     } else {
817       // Otherwise open the stream directly
818       if (page == null)
819         return null;
820       FileStorage storage = new FileStorage(path);
821       IEditorRegistry registry = getWorkbench().getEditorRegistry();
822       IEditorDescriptor desc = registry.getDefaultEditor(filename);
823       if (desc == null) {
824         desc = registry.findEditor(IEditorRegistry.SYSTEM_EXTERNAL_EDITOR_ID);
825         //   desc = registry.getDefaultEditor();
826       }
827       IEditorInput input = new ExternalEditorInput(storage);
828       editor = page.openEditor(input, desc.getId());
829       textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
830       // If the storage provider is not ours, we can't guarantee read/write.
831       if (textEditor != null) {
832         IDocumentProvider documentProvider = textEditor.getDocumentProvider();
833         if (!(documentProvider instanceof ExternalStorageDocumentProvider)) {
834           storage.setReadOnly();
835         }
836       }
837     }
838     return textEditor;
839   }
840
841   /**
842    * Open a file in the Workbench that may or may not exist in the workspace.
843    * Must be run on the UI thread.
844    * 
845    * @param filename
846    * @param line
847    * @throws CoreException
848    */
849   public void openFileAndGotoLine(String filename, int line)
850       throws CoreException {
851     ITextEditor textEditor = openFileInTextEditor(filename);
852     if (textEditor != null) {
853       // If a line number was given, go to it
854       if (line > 0) {
855         try {
856           line--; // document is 0 based
857           IDocument document = textEditor.getDocumentProvider().getDocument(
858               textEditor.getEditorInput());
859           textEditor.selectAndReveal(document.getLineOffset(line), document
860               .getLineLength(line));
861         } catch (BadLocationException e) {
862           // invalid text position -> do nothing
863         }
864       }
865     }
866   }
867
868   /**
869    * Open a file in the Workbench that may or may not exist in the workspace.
870    * Must be run on the UI thread.
871    * 
872    * @param filename
873    * @param offset
874    * @throws CoreException
875    */
876   public void openFileAndGotoOffset(String filename, int offset, int length)
877       throws CoreException {
878     ITextEditor textEditor = openFileInTextEditor(filename);
879     if (textEditor != null) {
880       // If a line number was given, go to it
881       if (offset >= 0) {
882         IDocument document = textEditor.getDocumentProvider().getDocument(
883             textEditor.getEditorInput());
884         textEditor.selectAndReveal(offset, length);
885       }
886     }
887   }
888
889   public void openFileAndFindString(String filename, String findString)
890       throws CoreException {
891     ITextEditor textEditor = openFileInTextEditor(filename);
892     if (textEditor != null) {
893       //                If a string was given, go to it
894       if (findString != null) {
895         try {
896           IDocument document = textEditor.getDocumentProvider().getDocument(
897               textEditor.getEditorInput());
898           int offset = document.search(0, findString, true, false, true);
899           textEditor.selectAndReveal(offset, findString.length());
900         } catch (BadLocationException e) {
901           // invalid text position -> do nothing
902         }
903       }
904     }
905   }
906
907   public void setLastEditorFile(IFile textEditor) {
908     this.fLastEditorFile = textEditor;
909   }
910
911   /*
912    * @see org.eclipse.core.runtime.Plugin#stop
913    */
914   public void stop(BundleContext context) throws Exception {
915     try {
916       //                        JavaCore.stop(this, context);
917       plugin.savePluginPreferences();
918       IWorkspace workspace = ResourcesPlugin.getWorkspace();
919       workspace.removeResourceChangeListener(JavaModelManager
920           .getJavaModelManager().deltaState);
921       workspace.removeSaveParticipant(plugin);
922
923       JavaModelManager.getJavaModelManager().shutdown();
924
925       ColorManager.getDefault().dispose();
926       // save the information from the php index files if necessary
927       Collection collection = fIndexManagerMap.values();
928       Iterator iterator = collection.iterator();
929       IdentifierIndexManager indexManager = null;
930       while (iterator.hasNext()) {
931         indexManager = (IdentifierIndexManager) iterator.next();
932         indexManager.writeFile();
933       }
934       if (fImageDescriptorRegistry != null)
935         fImageDescriptorRegistry.dispose();
936
937       //                        AllTypesCache.terminate();
938
939       if (fImageDescriptorRegistry != null)
940         fImageDescriptorRegistry.dispose();
941
942       unregisterAdapters();
943
944       //                        if (fASTProvider != null) {
945       //                                fASTProvider.dispose();
946       //                                fASTProvider= null;
947       //                        }
948
949       if (fWorkingCopyManager != null) {
950         fWorkingCopyManager.shutdown();
951         fWorkingCopyManager = null;
952       }
953
954       if (fCompilationUnitDocumentProvider != null) {
955         fCompilationUnitDocumentProvider.shutdown();
956         fCompilationUnitDocumentProvider = null;
957       }
958
959       if (fJavaTextTools != null) {
960         fJavaTextTools.dispose();
961         fJavaTextTools = null;
962       }
963       //                        JavaDocLocations.shutdownJavadocLocations();
964
965       uninstallPreferenceStoreBackwardsCompatibility();
966
967       //                        RefactoringCore.getUndoManager().shutdown();
968     } finally {
969       super.stop(context);
970     }
971   }
972
973   /**
974    * @see org.eclipse.ui.plugin.AbstractUIPlugin#shutdown()
975    */
976   //  public void shutdown() throws CoreException {
977   //    // moved down (see below):
978   //    // super.shutdown();
979   //    // externalTools.shutDown();
980   //    ColorManager.getDefault().dispose();
981   //    // save the information from the php index files if necessary
982   //    Collection collection = fIndexManagerMap.values();
983   //    Iterator iterator = collection.iterator();
984   //    IdentifierIndexManager indexManager = null;
985   //    while (iterator.hasNext()) {
986   //      indexManager = (IdentifierIndexManager) iterator.next();
987   //      indexManager.writeFile();
988   //    }
989   //    if (fImageDescriptorRegistry != null)
990   //      fImageDescriptorRegistry.dispose();
991   //    // unregisterAdapters();
992   //    super.shutdown();
993   //    if (fWorkingCopyManager != null) {
994   //      fWorkingCopyManager.shutdown();
995   //      fWorkingCopyManager = null;
996   //    }
997   //    if (fCompilationUnitDocumentProvider != null) {
998   //      fCompilationUnitDocumentProvider.shutdown();
999   //      fCompilationUnitDocumentProvider = null;
1000   //    }
1001   //    if (fJavaTextTools != null) {
1002   //      fJavaTextTools.dispose();
1003   //      fJavaTextTools = null;
1004   //    }
1005   //    // JavaDocLocations.shutdownJavadocLocations();
1006   //    //
1007   //    //
1008   // JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener);
1009   //    // begin JavaCore#shutdown()
1010   //    //savePluginPreferences();
1011   //    savePluginPreferences();
1012   //    IWorkspace workspace = ResourcesPlugin.getWorkspace();
1013   //    workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState);
1014   //    workspace.removeSaveParticipant(this);
1015   //    ((JavaModelManager) JavaModelManager.getJavaModelManager()).shutdown();
1016   //    // end JavaCore#shutdown()
1017   //  }
1018   /**
1019    * Installs backwards compatibility for the preference store.
1020    */
1021   private void installPreferenceStoreBackwardsCompatibility() {
1022
1023     /*
1024      * Installs backwards compatibility: propagate the Java editor font from a
1025      * pre-2.1 plug-in to the Platform UI's preference store to preserve the
1026      * Java editor font from a pre-2.1 workspace. This is done only once.
1027      */
1028     String fontPropagatedKey = "fontPropagated"; //$NON-NLS-1$
1029     if (getPreferenceStore().contains(JFaceResources.TEXT_FONT)
1030         && !getPreferenceStore().isDefault(JFaceResources.TEXT_FONT)) {
1031       if (!getPreferenceStore().getBoolean(fontPropagatedKey))
1032         PreferenceConverter.setValue(PlatformUI.getWorkbench()
1033             .getPreferenceStore(), PreferenceConstants.EDITOR_TEXT_FONT,
1034             PreferenceConverter.getFontDataArray(getPreferenceStore(),
1035                 JFaceResources.TEXT_FONT));
1036     }
1037     getPreferenceStore().setValue(fontPropagatedKey, true);
1038
1039     /*
1040      * Backwards compatibility: set the Java editor font in this plug-in's
1041      * preference store to let older versions access it. Since 2.1 the Java
1042      * editor font is managed by the workbench font preference page.
1043      */
1044     PreferenceConverter.putValue(getPreferenceStore(),
1045         JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry().getFontData(
1046             PreferenceConstants.EDITOR_TEXT_FONT));
1047
1048     fFontPropertyChangeListener = new IPropertyChangeListener() {
1049       public void propertyChange(PropertyChangeEvent event) {
1050         if (PreferenceConstants.EDITOR_TEXT_FONT.equals(event.getProperty()))
1051           PreferenceConverter.putValue(getPreferenceStore(),
1052               JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry()
1053                   .getFontData(PreferenceConstants.EDITOR_TEXT_FONT));
1054       }
1055     };
1056     JFaceResources.getFontRegistry().addListener(fFontPropertyChangeListener);
1057
1058     /*
1059      * Backwards compatibility: propagate the Java editor tab width from a
1060      * pre-3.0 plug-in to the new preference key. This is done only once.
1061      */
1062     final String oldTabWidthKey = PreferenceConstants.EDITOR_TAB_WIDTH;
1063     final String newTabWidthKey = AbstractDecoratedTextEditorPreferenceConstants.EDITOR_TAB_WIDTH;
1064     String tabWidthPropagatedKey = "tabWidthPropagated"; //$NON-NLS-1$
1065     if (getPreferenceStore().contains(oldTabWidthKey)
1066         && !getPreferenceStore().isDefault(oldTabWidthKey)) {
1067       if (!getPreferenceStore().getBoolean(tabWidthPropagatedKey))
1068         getPreferenceStore().setValue(newTabWidthKey,
1069             getPreferenceStore().getInt(oldTabWidthKey));
1070     }
1071     getPreferenceStore().setValue(tabWidthPropagatedKey, true);
1072
1073     /*
1074      * Backwards compatibility: set the Java editor tab width in this plug-in's
1075      * preference store with the old key to let older versions access it. Since
1076      * 3.0 the tab width is managed by the extended texteditor and uses a new
1077      * key.
1078      */
1079     getPreferenceStore().putValue(oldTabWidthKey,
1080         getPreferenceStore().getString(newTabWidthKey));
1081
1082     fPropertyChangeListener = new IPropertyChangeListener() {
1083       public void propertyChange(PropertyChangeEvent event) {
1084         if (newTabWidthKey.equals(event.getProperty()))
1085           getPreferenceStore().putValue(oldTabWidthKey,
1086               getPreferenceStore().getString(newTabWidthKey));
1087       }
1088     };
1089     getPreferenceStore().addPropertyChangeListener(fPropertyChangeListener);
1090
1091     /*
1092      * Backward compatibility for the refactoring preference key.
1093      */
1094     //          getPreferenceStore().setValue(
1095     //                  PreferenceConstants.REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD,
1096     //                  RefactoringCore.getConditionCheckingFailedSeverity());
1097   }
1098
1099   /**
1100    * Uninstalls backwards compatibility for the preference store.
1101    */
1102   private void uninstallPreferenceStoreBackwardsCompatibility() {
1103     JFaceResources.getFontRegistry()
1104         .removeListener(fFontPropertyChangeListener);
1105     getPreferenceStore().removePropertyChangeListener(fPropertyChangeListener);
1106   }
1107
1108   /*
1109    * (non - Javadoc) Method declared in Plugin
1110    */
1111   public void start(BundleContext context) throws Exception {
1112     super.start(context);
1113
1114     //          JavaCore.start(this, context);
1115     final JavaModelManager manager = JavaModelManager.getJavaModelManager();
1116     try {
1117       manager.configurePluginDebugOptions();
1118
1119       // request state folder creation (workaround 19885)
1120       //      JavaCore.getPlugin().getStateLocation();
1121       getStateLocation();
1122       // retrieve variable values
1123       //JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new
1124       // JavaModelManager.PluginPreferencesListener());
1125       //                        manager.loadVariablesAndContainers();
1126
1127       final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1128       workspace.addResourceChangeListener(manager.deltaState,
1129           IResourceChangeEvent.PRE_BUILD | IResourceChangeEvent.POST_BUILD
1130               | IResourceChangeEvent.POST_CHANGE
1131               | IResourceChangeEvent.PRE_DELETE
1132               | IResourceChangeEvent.PRE_CLOSE);
1133
1134       //                        startIndexing();
1135
1136       //  process deltas since last activated in indexer thread so that indexes
1137       // are up-to-date.
1138       // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=38658
1139       Job processSavedState = new Job(Util.bind("savedState.jobName")) { //$NON-NLS-1$
1140         protected IStatus run(IProgressMonitor monitor) {
1141           try {
1142             // add save participant and process delta atomically
1143             // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=59937
1144             workspace.run(new IWorkspaceRunnable() {
1145               public void run(IProgressMonitor progress) throws CoreException {
1146                 ISavedState savedState = workspace.addSaveParticipant(
1147                     PHPeclipsePlugin.this, manager);
1148                 if (savedState != null) {
1149                   // the event type coming from the saved state is always
1150                   // POST_AUTO_BUILD
1151                   // force it to be POST_CHANGE so that the delta processor can
1152                   // handle it
1153                   manager.deltaState.getDeltaProcessor().overridenEventType = IResourceChangeEvent.POST_CHANGE;
1154                   savedState.processResourceChangeEvents(manager.deltaState);
1155                 }
1156               }
1157             }, monitor);
1158           } catch (CoreException e) {
1159             return e.getStatus();
1160           }
1161           return Status.OK_STATUS;
1162         }
1163       };
1164       processSavedState.setSystem(true);
1165       processSavedState.setPriority(Job.SHORT); // process asap
1166       processSavedState.schedule();
1167
1168     } catch (RuntimeException e) {
1169       manager.shutdown();
1170       throw e;
1171     }
1172
1173     registerAdapters();
1174
1175     //  if (USE_WORKING_COPY_OWNERS) {
1176     WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1177       public IBuffer createBuffer(ICompilationUnit workingCopy) {
1178         ICompilationUnit original = workingCopy.getPrimary();
1179         IResource resource = original.getResource();
1180         if (resource instanceof IFile)
1181           return new DocumentAdapter(workingCopy, (IFile) resource);
1182         return DocumentAdapter.NULL;
1183       }
1184     });
1185     //  }
1186
1187     installPreferenceStoreBackwardsCompatibility();
1188
1189   }
1190
1191   //    registerAdapters();
1192   //
1193   //     // externalTools.startUp();
1194   //    getStandardDisplay().asyncExec(new Runnable() {
1195   //      public void run() {
1196   //        //initialize the variable context manager
1197   //        VariableContextManager.getDefault();
1198   //      }
1199   //    });
1200   //
1201   //    // if (USE_WORKING_COPY_OWNERS) {
1202   //    WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1203   //      public IBuffer createBuffer(ICompilationUnit workingCopy) {
1204   //        ICompilationUnit original = workingCopy.getPrimary();
1205   //        IResource resource = original.getResource();
1206   //        if (resource instanceof IFile)
1207   //          return new DocumentAdapter(workingCopy, (IFile) resource);
1208   //        return DocumentAdapter.NULL;
1209   //      }
1210   //    });
1211   //    // }
1212
1213   //    installPreferenceStoreBackwardsCompatibility();
1214
1215   //            AllTypesCache.initialize();
1216
1217   // Initialize AST provider
1218   //            getASTProvider();
1219   //  }
1220
1221   //  public void startup() throws CoreException {
1222   //    super.startup();
1223   //    // begin JavaCore.startup();
1224   //    JavaModelManager manager = JavaModelManager.getJavaModelManager();
1225   //    try {
1226   //      manager.configurePluginDebugOptions();
1227   //      // request state folder creation (workaround 19885)
1228   //      // JavaCore.getPlugin().getStateLocation();
1229   //      getStateLocation();
1230   //      // retrieve variable values
1231   //      //
1232   // JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new
1233   //      // JavaModelManager.PluginPreferencesListener());
1234   //      getPluginPreferences().addPropertyChangeListener(
1235   //          new JavaModelManager.PluginPreferencesListener());
1236   //      // TODO khartlage temp-del
1237   //      // manager.loadVariablesAndContainers();
1238   //      final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1239   //            workspace.addResourceChangeListener(
1240   //                    manager.deltaState,
1241   //                    IResourceChangeEvent.PRE_BUILD
1242   //                            | IResourceChangeEvent.POST_BUILD
1243   //                            | IResourceChangeEvent.POST_CHANGE
1244   //                            | IResourceChangeEvent.PRE_DELETE
1245   //                            | IResourceChangeEvent.PRE_CLOSE);
1246   //      // startIndexing();
1247   //      workspace.addSaveParticipant(PHPeclipsePlugin.getDefault(), manager);
1248   //    } catch (CoreException e) {
1249   //    } catch (RuntimeException e) {
1250   //      manager.shutdown();
1251   //      throw e;
1252   //    }
1253   //    // end JavaCore.startup();
1254   //    IAdapterManager platformManager = Platform.getAdapterManager();
1255   //    platformManager.registerAdapters(new PHPElementAdapterFactory(),
1256   //        PHPElement.class);
1257   //    platformManager.registerAdapters(new ResourceAdapterFactory(),
1258   //        IResource.class);
1259   //    // externalTools.startUp();
1260   //    getStandardDisplay().asyncExec(new Runnable() {
1261   //      public void run() {
1262   //        //initialize the variable context manager
1263   //        VariableContextManager.getDefault();
1264   //      }
1265   //    });
1266   //  }
1267
1268   private void registerAdapters() {
1269     fJavaElementAdapterFactory = new JavaElementAdapterFactory();
1270     //          fMarkerAdapterFactory= new MarkerAdapterFactory();
1271     //          fEditorInputAdapterFactory= new EditorInputAdapterFactory();
1272     fResourceAdapterFactory = new ResourceAdapterFactory();
1273     //          fLogicalPackageAdapterFactory= new LogicalPackageAdapterFactory();
1274
1275     IAdapterManager manager = Platform.getAdapterManager();
1276     manager.registerAdapters(fJavaElementAdapterFactory, IJavaElement.class);
1277     //          manager.registerAdapters(fMarkerAdapterFactory, IMarker.class);
1278     //          manager.registerAdapters(fEditorInputAdapterFactory, IEditorInput.class);
1279     manager.registerAdapters(fResourceAdapterFactory, IResource.class);
1280     //          manager.registerAdapters(fLogicalPackageAdapterFactory,
1281     // LogicalPackage.class);
1282   }
1283
1284   private void unregisterAdapters() {
1285     IAdapterManager manager = Platform.getAdapterManager();
1286     manager.unregisterAdapters(fJavaElementAdapterFactory);
1287     //          manager.unregisterAdapters(fMarkerAdapterFactory);
1288     //          manager.unregisterAdapters(fEditorInputAdapterFactory);
1289     manager.unregisterAdapters(fResourceAdapterFactory);
1290     //          manager.unregisterAdapters(fLogicalPackageAdapterFactory);
1291   }
1292
1293   /**
1294    * Returns a combined preference store, this store is read-only.
1295    * 
1296    * @return the combined preference store
1297    * 
1298    * @since 3.0
1299    */
1300   public IPreferenceStore getCombinedPreferenceStore() {
1301     if (fCombinedPreferenceStore == null) {
1302       IPreferenceStore generalTextStore = EditorsUI.getPreferenceStore();
1303       fCombinedPreferenceStore = new ChainedPreferenceStore(
1304           new IPreferenceStore[] {
1305               getPreferenceStore(),
1306               new PreferencesAdapter(PHPeclipsePlugin.getDefault()
1307                   .getPluginPreferences()), generalTextStore });
1308     }
1309     return fCombinedPreferenceStore;
1310   }
1311
1312   public synchronized IBufferFactory getBufferFactory() {
1313     if (fBufferFactory == null)
1314       fBufferFactory = new CustomBufferFactory();
1315     return fBufferFactory;
1316   }
1317
1318   /**
1319    * Returns the registry of the extensions to the
1320    * <code>org.eclipse.jdt.ui.javaFoldingStructureProvider</code> extension
1321    * point.
1322    * 
1323    * @return the registry of contributed
1324    *         <code>IJavaFoldingStructureProvider</code>
1325    * @since 3.0
1326    */
1327   public synchronized JavaFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() {
1328     if (fFoldingStructureProviderRegistry == null)
1329       fFoldingStructureProviderRegistry = new JavaFoldingStructureProviderRegistry();
1330     return fFoldingStructureProviderRegistry;
1331   }
1332
1333   /**
1334    * Runs the given action as an atomic Java model operation.
1335    * <p>
1336    * After running a method that modifies java elements, registered listeners
1337    * receive after-the-fact notification of what just transpired, in the form of
1338    * a element changed event. This method allows clients to call a number of
1339    * methods that modify java elements and only have element changed event
1340    * notifications reported at the end of the entire batch.
1341    * </p>
1342    * <p>
1343    * If this method is called outside the dynamic scope of another such call,
1344    * this method runs the action and then reports a single element changed event
1345    * describing the net effect of all changes done to java elements by the
1346    * action.
1347    * </p>
1348    * <p>
1349    * If this method is called in the dynamic scope of another such call, this
1350    * method simply runs the action.
1351    * </p>
1352    * 
1353    * @param action
1354    *          the action to perform
1355    * @param monitor
1356    *          a progress monitor, or <code>null</code> if progress reporting
1357    *          and cancellation are not desired
1358    * @exception CoreException
1359    *              if the operation failed.
1360    * @since 2.1
1361    */
1362   public static void run(IWorkspaceRunnable action, IProgressMonitor monitor)
1363       throws CoreException {
1364     run(action, ResourcesPlugin.getWorkspace().getRoot(), monitor);
1365   }
1366
1367   /**
1368    * Runs the given action as an atomic Java model operation.
1369    * <p>
1370    * After running a method that modifies java elements, registered listeners
1371    * receive after-the-fact notification of what just transpired, in the form of
1372    * a element changed event. This method allows clients to call a number of
1373    * methods that modify java elements and only have element changed event
1374    * notifications reported at the end of the entire batch.
1375    * </p>
1376    * <p>
1377    * If this method is called outside the dynamic scope of another such call,
1378    * this method runs the action and then reports a single element changed event
1379    * describing the net effect of all changes done to java elements by the
1380    * action.
1381    * </p>
1382    * <p>
1383    * If this method is called in the dynamic scope of another such call, this
1384    * method simply runs the action.
1385    * </p>
1386    * <p>
1387    * The supplied scheduling rule is used to determine whether this operation
1388    * can be run simultaneously with workspace changes in other threads. See
1389    * <code>IWorkspace.run(...)</code> for more details.
1390    * </p>
1391    * 
1392    * @param action
1393    *          the action to perform
1394    * @param rule
1395    *          the scheduling rule to use when running this operation, or
1396    *          <code>null</code> if there are no scheduling restrictions for
1397    *          this operation.
1398    * @param monitor
1399    *          a progress monitor, or <code>null</code> if progress reporting
1400    *          and cancellation are not desired
1401    * @exception CoreException
1402    *              if the operation failed.
1403    * @since 3.0
1404    */
1405   public static void run(IWorkspaceRunnable action, ISchedulingRule rule,
1406       IProgressMonitor monitor) throws CoreException {
1407     IWorkspace workspace = ResourcesPlugin.getWorkspace();
1408     if (workspace.isTreeLocked()) {
1409       new BatchOperation(action).run(monitor);
1410     } else {
1411       // use IWorkspace.run(...) to ensure that a build will be done in
1412       // autobuild mode
1413       workspace.run(new BatchOperation(action), rule, IWorkspace.AVOID_UPDATE,
1414           monitor);
1415     }
1416   }
1417 }