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