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