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(
 700                 new Path("prefs/default_" + operatingSystem + ".properties"));
 701       PropertyResourceBundle resourceBundle = new PropertyResourceBundle(is);
 702       Enumeration enum = resourceBundle.getKeys();
 703       String key;
 704       while (enum.hasMoreElements()) {
 705         key = (String)enum.nextElement();
 706         store.setDefault(key, resourceBundle.getString( key ));
 707       }
 708     } catch (Exception e) {
 709       // no default properties found
 710       if (operatingSystem.equals(Platform.OS_WIN32)) {
 711         store.setDefault(PHP_RUN_PREF, "c:\\apache\\php\\php.exe");
 712         store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
 713         store.setDefault(MYSQL_RUN_PREF, "c:\\apache\\mysql\\bin\\mysqld-nt.exe");
 714         store.setDefault(APACHE_RUN_PREF, "c:\\apache\\apache.exe");
 715         store.setDefault(XAMPP_START_PREF, "c:\\xampp\\xampp_start.exe");
 716         store.setDefault(XAMPP_STOP_PREF, "c:\\xampp\\xampp_stop.exe");
 717         store.setDefault(
 718                 ETC_HOSTS_PATH_PREF, "c:\\windows\\system32\\drivers\\etc\\hosts");
 719       } else {
 720         store.setDefault(PHP_RUN_PREF, "/apache/php/php");
 721         store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
 722         store.setDefault(MYSQL_RUN_PREF, "/apache/mysql/bin/mysqld");
 723         store.setDefault(APACHE_RUN_PREF, "/apache/apache");
 724         store.setDefault(XAMPP_START_PREF, "xamp/xampp_start");
 725         store.setDefault(XAMPP_STOP_PREF, "xampp/xampp_stop");
 726       }
 727       store.setDefault(MYSQL_PREF, "--standalone");
 728       store.setDefault(APACHE_START_PREF, "-c \"DocumentRoot \"{0}\"\"");
 729       store.setDefault(APACHE_STOP_PREF, "-k shutdown");
 730       store.setDefault(APACHE_RESTART_PREF, "-k restart");
 731       store.setDefault(MYSQL_START_BACKGROUND, "true");
 732       store.setDefault(APACHE_START_BACKGROUND, "true");
 733       store.setDefault(APACHE_STOP_BACKGROUND, "true");
 734       store.setDefault(APACHE_RESTART_BACKGROUND, "true");
 735     }
 736
 737     store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
 738     store.setDefault(PHP_OBFUSCATOR_DEFAULT, "c:\\temp");
 739     if (operatingSystem.equals(Platform.OS_WIN32)) {
 740       //    store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}");
 741     } else if (operatingSystem.equals(Platform.OS_MACOSX)) {
 742       store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp");
 743       // TODO How do we start Safari on Mac OS X ?
 744       //    store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
 745     } else {
 746       store.setDefault(PHP_OBFUSCATOR_DEFAULT, "/tmp");
 747       //    store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
 748     }
 749
 750     store.setDefault(PHP_EXTENSION_PREFS, "php,php3,php4,php5,phtml,inc,module,class");
 751
 752     //    store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
 753     //    store.setDefault(PHP_INTERNAL_PARSER, "false");
 754     //    store.setDefault(PHP_EXTERNAL_PARSER, "true");
 755     //    store.setDefault(PHP_PARSE_ON_SAVE, "true");
 756     // show line numbers:
 757     //   store.setDefault(LINE_NUMBER_RULER, "false");
 758     //    store.setDefault(FORMATTER_TAB_SIZE, "4");
 759     // php syntax highlighting
 760     store.setDefault(PHP_USERDEF_XMLFILE, "");
 761     //assume there is none chooA
 762 //    PreferenceConverter.setDefault(store, PHP_MULTILINE_COMMENT, PHPColorProvider.MULTI_LINE_COMMENT);
 763 //    PreferenceConverter.setDefault(store, PHP_SINGLELINE_COMMENT, PHPColorProvider.SINGLE_LINE_COMMENT);
 764     PreferenceConverter.setDefault(store, PHP_TAG, PHPColorProvider.TAG);
 765     PreferenceConverter.setDefault(store, PHP_KEYWORD, PHPColorProvider.KEYWORD);
 766     PreferenceConverter.setDefault(store, PHP_VARIABLE, PHPColorProvider.VARIABLE);
 767     PreferenceConverter.setDefault(store, PHP_FUNCTIONNAME, PHPColorProvider.FUNCTION_NAME);
 768     PreferenceConverter.setDefault(store, PHP_CONSTANT, PHPColorProvider.CONSTANT);
 769     PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
 770 //    PreferenceConverter.setDefault(store, PHP_STRING_DQ, PHPColorProvider.STRING_DQ);
 771 //    store.setDefault(PHP_STRING_BOLD_DQ, true);
 772 //    PreferenceConverter.setDefault(store, PHP_STRING_SQ, PHPColorProvider.STRING_SQ);
 773     PreferenceConverter.setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
 774     PreferenceConverter.setDefault(store, PHPDOC_KEYWORD, PHPColorProvider.PHPDOC_KEYWORD);
 775     PreferenceConverter.setDefault(store, PHPDOC_TAG, PHPColorProvider.PHPDOC_TAG);
 776     PreferenceConverter.setDefault(store, PHPDOC_LINK, PHPColorProvider.PHPDOC_LINK);
 777     PreferenceConverter.setDefault(store, PHPDOC_DEFAULT, PHPColorProvider.PHPDOC_DEFAULT);
 778
 779     PreferenceConverter.setDefault(store, EDITOR_PHP_KEYWORD_RETURN_COLOR, new RGB(127, 0, 85));
 780     store.setDefault(EDITOR_PHP_KEYWORD_RETURN_BOLD, true);
 781     store.setDefault(EDITOR_PHP_KEYWORD_RETURN_ITALIC, false);
 782
 783     PreferenceConverter.setDefault(store, EDITOR_PHP_OPERATOR_COLOR, new RGB(0, 0, 0));
 784     store.setDefault(EDITOR_PHP_OPERATOR_BOLD, false);
 785     store.setDefault(EDITOR_PHP_OPERATOR_ITALIC, false);
 786
 787     PreferenceConverter.setDefault(store, EDITOR_PHP_BRACE_OPERATOR_COLOR, new RGB(0, 0, 0));
 788     store.setDefault(EDITOR_PHP_BRACE_OPERATOR_BOLD, false);
 789     store.setDefault(EDITOR_PHP_BRACE_OPERATOR_ITALIC, false);
 790     //    PreferenceConverter.setDefault(
 791     //      store,
 792     //      PHP_EDITOR_BACKGROUND,
 793     //      PHPColorProvider.BACKGROUND);
 794     //    PreferenceConverter.setDefault(
 795     //      store,
 796     //      LINKED_POSITION_COLOR,
 797     //      PHPColorProvider.LINKED_POSITION_COLOR);
 798     //    PreferenceConverter.setDefault(
 799     //      store,
 800     //      LINE_NUMBER_COLOR,
 801     //      PHPColorProvider.LINE_NUMBER_COLOR);
 802     //    // set default PHPDoc colors:
 803     //    PreferenceConverter.setDefault(
 804     //      store,
 805     //      PHPDOC_KEYWORD,
 806     //      PHPColorProvider.PHPDOC_KEYWORD);
 807     //    PreferenceConverter.setDefault(
 808     //      store,
 809     //      PHPDOC_LINK,
 810     //      PHPColorProvider.PHPDOC_LINK);
 811     //    PreferenceConverter.setDefault(
 812     //      store,
 813     //      PHPDOC_DEFAULT,
 814     //      PHPColorProvider.PHPDOC_DEFAULT);
 815     //    PreferenceConverter.setDefault(
 816     //      store,
 817     //      PHPDOC_TAG,
 818     //      PHPColorProvider.PHPDOC_TAG);
 819     //    store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
 820     //    PreferenceConverter.setDefault(
 821     //      store,
 822     //      PREFERENCE_COLOR_BACKGROUND,
 823     //      PHPColorProvider.BACKGROUND_COLOR);
 824     //language stuff
 825     //    store.setDefault(RESOURCE_BUNDLE, LANGUAGE_DEFAULT);
 826     //    store.setDefault(RESOURCE_BUNDLE_EN_GB, "true");
 827     //    store.setDefault(RESOURCE_BUNDLE_DE, "false");
 828     //    store.setDefault(RESOURCE_BUNDLE_FR, "false");
 829     //    store.setDefault(RESOURCE_BUNDLE_ES, "false");
 830     //    TemplatePreferencePage.initDefaults(store);
 831     //this will initialize the static fields in the syntaxrdr class
 832     new PHPSyntaxRdr();
 833     JavaCore.initializeDefaultPluginPreferences();
 834     PreferenceConstants.initializeDefaultValues(store);
 835     externalTools.initializeDefaultPreferences(store);
 836     MarkerAnnotationPreferences.initializeDefaultValues(store);
 837   }
 838
 839   private IWorkbenchPage internalGetActivePage() {
 840     IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
 841     if (window != null)
 842       return window.getActivePage();
 843     return null;
 844   }
 845
 846   private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
 847     if (fImageDescriptorRegistry == null)
 848       fImageDescriptorRegistry = new ImageDescriptorRegistry();
 849     return fImageDescriptorRegistry;
 850   }
 851
 852   /**
 853    * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
 854    *
 855    * @param filename
 856    * @throws CoreException
 857    */
 858   public ITextEditor openFileInTextEditor(String filename) throws CoreException {
 859     //  reject directories
 860     if (new File(filename).isDirectory())
 861       return null;
 862     IWorkbench workbench = PlatformUI.getWorkbench();
 863     IWorkbenchWindow window = workbench.getWorkbenchWindows()[0];
 864     IWorkbenchPage page = window.getActivePage();
 865     IPath path = new Path(filename);
 866     // If the file exists in the workspace, open it
 867     IFile file = getWorkspace().getRoot().getFileForLocation(path);
 868     IEditorPart editor;
 869     ITextEditor textEditor;
 870     if (file != null && file.exists()) {
 871       editor = IDE.openEditor(page, file, true);
 872       textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
 873     } else {
 874       // Otherwise open the stream directly
 875       if (page == null)
 876         return null;
 877       FileStorage storage = new FileStorage(path);
 878       IEditorRegistry registry = getWorkbench().getEditorRegistry();
 879       IEditorDescriptor desc = registry.getDefaultEditor(filename);
 880       if (desc == null) {
 881         desc = registry.findEditor(IEditorRegistry.SYSTEM_EXTERNAL_EDITOR_ID);
 882         //   desc = registry.getDefaultEditor();
 883       }
 884       IEditorInput input = new ExternalEditorInput(storage);
 885       editor = page.openEditor(input, desc.getId());
 886       textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
 887       // If the storage provider is not ours, we can't guarantee read/write.
 888       if (textEditor != null) {
 889         IDocumentProvider documentProvider = textEditor.getDocumentProvider();
 890         if (!(documentProvider instanceof ExternalStorageDocumentProvider)) {
 891           storage.setReadOnly();
 892         }
 893       }
 894     }
 895     return textEditor;
 896   }
 897
 898   /**
 899    * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
 900    *
 901    * @param filename
 902    * @param line
 903    * @throws CoreException
 904    */
 905   public void openFileAndGotoLine(String filename, int line) throws CoreException {
 906     ITextEditor textEditor = openFileInTextEditor(filename);
 907     if (textEditor != null) {
 908       // If a line number was given, go to it
 909       if (line > 0) {
 910         try {
 911           line--; // document is 0 based
 912           IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
 913           textEditor.selectAndReveal(document.getLineOffset(line), document.getLineLength(line));
 914         } catch (BadLocationException e) {
 915           // invalid text position -> do nothing
 916         }
 917       }
 918     }
 919   }
 920
 921   /**
 922    * Open a file in the Workbench that may or may not exist in the workspace. Must be run on the UI thread.
 923    *
 924    * @param filename
 925    * @param offset
 926    * @throws CoreException
 927    */
 928   public void openFileAndGotoOffset(String filename, int offset, int length) throws CoreException {
 929     ITextEditor textEditor = openFileInTextEditor(filename);
 930     if (textEditor != null) {
 931       // If a line number was given, go to it
 932       if (offset >= 0) {
 933         IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
 934         textEditor.selectAndReveal(offset, length);
 935       }
 936     }
 937   }
 938
 939   public void openFileAndFindString(String filename, String findString) throws CoreException {
 940     ITextEditor textEditor = openFileInTextEditor(filename);
 941     if (textEditor != null) {
 942       //                If a string was given, go to it
 943       if (findString != null) {
 944         try {
 945           IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
 946           int offset = document.search(0, findString, true, false, true);
 947           textEditor.selectAndReveal(offset, findString.length());
 948         } catch (BadLocationException e) {
 949           // invalid text position -> do nothing
 950         }
 951       }
 952     }
 953   }
 954
 955   public void setLastEditorFile(IFile textEditor) {
 956     this.fLastEditorFile = textEditor;
 957   }
 958
 959   /*
 960    * @see org.eclipse.core.runtime.Plugin#stop
 961    */
 962   public void stop(BundleContext context) throws Exception {
 963     try {
 964       //                        JavaCore.stop(this, context);
 965       plugin.savePluginPreferences();
 966       IWorkspace workspace = ResourcesPlugin.getWorkspace();
 967       workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState);
 968       workspace.removeSaveParticipant(plugin);
 969
 970       JavaModelManager.getJavaModelManager().shutdown();
 971
 972       ColorManager.getDefault().dispose();
 973       // save the information from the php index files if necessary
 974       Collection collection = fIndexManagerMap.values();
 975       Iterator iterator = collection.iterator();
 976       IdentifierIndexManager indexManager = null;
 977       while (iterator.hasNext()) {
 978         indexManager = (IdentifierIndexManager) iterator.next();
 979         indexManager.writeFile();
 980       }
 981       if (fImageDescriptorRegistry != null)
 982         fImageDescriptorRegistry.dispose();
 983
 984       //                        AllTypesCache.terminate();
 985
 986       if (fImageDescriptorRegistry != null)
 987         fImageDescriptorRegistry.dispose();
 988
 989       unregisterAdapters();
 990
 991       //                        if (fASTProvider != null) {
 992       //                                fASTProvider.dispose();
 993       //                                fASTProvider= null;
 994       //                        }
 995
 996       if (fWorkingCopyManager != null) {
 997         fWorkingCopyManager.shutdown();
 998         fWorkingCopyManager = null;
 999       }
1000
1001       if (fCompilationUnitDocumentProvider != null) {
1002         fCompilationUnitDocumentProvider.shutdown();
1003         fCompilationUnitDocumentProvider = null;
1004       }
1005
1006       if (fJavaTextTools != null) {
1007         fJavaTextTools.dispose();
1008         fJavaTextTools = null;
1009       }
1010       //                        JavaDocLocations.shutdownJavadocLocations();
1011
1012       uninstallPreferenceStoreBackwardsCompatibility();
1013
1014       //                        RefactoringCore.getUndoManager().shutdown();
1015     } finally {
1016       super.stop(context);
1017     }
1018   }
1019
1020   /**
1021    * @see org.eclipse.ui.plugin.AbstractUIPlugin#shutdown()
1022    */
1023   //  public void shutdown() throws CoreException {
1024   //    // moved down (see below):
1025   //    // super.shutdown();
1026   //    // externalTools.shutDown();
1027   //    ColorManager.getDefault().dispose();
1028   //    // save the information from the php index files if necessary
1029   //    Collection collection = fIndexManagerMap.values();
1030   //    Iterator iterator = collection.iterator();
1031   //    IdentifierIndexManager indexManager = null;
1032   //    while (iterator.hasNext()) {
1033   //      indexManager = (IdentifierIndexManager) iterator.next();
1034   //      indexManager.writeFile();
1035   //    }
1036   //    if (fImageDescriptorRegistry != null)
1037   //      fImageDescriptorRegistry.dispose();
1038   //    // unregisterAdapters();
1039   //    super.shutdown();
1040   //    if (fWorkingCopyManager != null) {
1041   //      fWorkingCopyManager.shutdown();
1042   //      fWorkingCopyManager = null;
1043   //    }
1044   //    if (fCompilationUnitDocumentProvider != null) {
1045   //      fCompilationUnitDocumentProvider.shutdown();
1046   //      fCompilationUnitDocumentProvider = null;
1047   //    }
1048   //    if (fJavaTextTools != null) {
1049   //      fJavaTextTools.dispose();
1050   //      fJavaTextTools = null;
1051   //    }
1052   //    // JavaDocLocations.shutdownJavadocLocations();
1053   //    //
1054   //    //
1055   // JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener);
1056   //    // begin JavaCore#shutdown()
1057   //    //savePluginPreferences();
1058   //    savePluginPreferences();
1059   //    IWorkspace workspace = ResourcesPlugin.getWorkspace();
1060   //    workspace.removeResourceChangeListener(JavaModelManager.getJavaModelManager().deltaState);
1061   //    workspace.removeSaveParticipant(this);
1062   //    ((JavaModelManager) JavaModelManager.getJavaModelManager()).shutdown();
1063   //    // end JavaCore#shutdown()
1064   //  }
1065   /**
1066    * Installs backwards compatibility for the preference store.
1067    */
1068   private void installPreferenceStoreBackwardsCompatibility() {
1069
1070     /*
1071      * Installs backwards compatibility: propagate the Java editor font from a pre-2.1 plug-in to the Platform UI's preference store
1072      * to preserve the Java editor font from a pre-2.1 workspace. This is done only once.
1073      */
1074     String fontPropagatedKey = "fontPropagated"; //$NON-NLS-1$
1075     if (getPreferenceStore().contains(JFaceResources.TEXT_FONT) && !getPreferenceStore().isDefault(JFaceResources.TEXT_FONT)) {
1076       if (!getPreferenceStore().getBoolean(fontPropagatedKey))
1077         PreferenceConverter.setValue(PlatformUI.getWorkbench().getPreferenceStore(), PreferenceConstants.EDITOR_TEXT_FONT,
1078             PreferenceConverter.getFontDataArray(getPreferenceStore(), JFaceResources.TEXT_FONT));
1079     }
1080     getPreferenceStore().setValue(fontPropagatedKey, true);
1081
1082     /*
1083      * Backwards compatibility: set the Java editor font in this plug-in's preference store to let older versions access it. Since
1084      * 2.1 the Java editor font is managed by the workbench font preference page.
1085      */
1086     PreferenceConverter.putValue(getPreferenceStore(), JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry().getFontData(
1087         PreferenceConstants.EDITOR_TEXT_FONT));
1088
1089     fFontPropertyChangeListener = new IPropertyChangeListener() {
1090       public void propertyChange(PropertyChangeEvent event) {
1091         if (PreferenceConstants.EDITOR_TEXT_FONT.equals(event.getProperty()))
1092           PreferenceConverter.putValue(getPreferenceStore(), JFaceResources.TEXT_FONT, JFaceResources.getFontRegistry()
1093               .getFontData(PreferenceConstants.EDITOR_TEXT_FONT));
1094       }
1095     };
1096     JFaceResources.getFontRegistry().addListener(fFontPropertyChangeListener);
1097
1098     /*
1099      * Backwards compatibility: propagate the Java editor tab width from a pre-3.0 plug-in to the new preference key. This is done
1100      * only once.
1101      */
1102     //    final String oldTabWidthKey = PreferenceConstants.EDITOR_TAB_WIDTH;
1103     //    final String newTabWidthKey = AbstractDecoratedTextEditorPreferenceConstants.EDITOR_TAB_WIDTH;
1104     //    String tabWidthPropagatedKey = "tabWidthPropagated"; //$NON-NLS-1$
1105     //    if (getPreferenceStore().contains(oldTabWidthKey) && !getPreferenceStore().isDefault(oldTabWidthKey)) {
1106     //      if (!getPreferenceStore().getBoolean(tabWidthPropagatedKey))
1107     //        getPreferenceStore().setValue(newTabWidthKey, getPreferenceStore().getInt(oldTabWidthKey));
1108     //    }
1109     //    getPreferenceStore().setValue(tabWidthPropagatedKey, true);
1110     //
1111     //    /*
1112     //     * Backwards compatibility: set the Java editor tab width in this plug-in's preference store with the old key to let older
1113     //     * versions access it. Since 3.0 the tab width is managed by the extended texteditor and uses a new key.
1114     //     */
1115     //    getPreferenceStore().putValue(oldTabWidthKey, getPreferenceStore().getString(newTabWidthKey));
1116     //    fPropertyChangeListener = new IPropertyChangeListener() {
1117     //      public void propertyChange(PropertyChangeEvent event) {
1118     //        if (newTabWidthKey.equals(event.getProperty()))
1119     //          getPreferenceStore().putValue(oldTabWidthKey, getPreferenceStore().getString(newTabWidthKey));
1120     //      }
1121     //    };
1122     //    getPreferenceStore().addPropertyChangeListener(fPropertyChangeListener);
1123     /*
1124      * Backward compatibility for the refactoring preference key.
1125      */
1126     //          getPreferenceStore().setValue(
1127     //                  PreferenceConstants.REFACTOR_ERROR_PAGE_SEVERITY_THRESHOLD,
1128     //                  RefactoringCore.getConditionCheckingFailedSeverity());
1129   }
1130
1131   /**
1132    * Uninstalls backwards compatibility for the preference store.
1133    */
1134   private void uninstallPreferenceStoreBackwardsCompatibility() {
1135     JFaceResources.getFontRegistry().removeListener(fFontPropertyChangeListener);
1136     //    getPreferenceStore().removePropertyChangeListener(fPropertyChangeListener);
1137   }
1138
1139   /*
1140    * (non - Javadoc) Method declared in Plugin
1141    */
1142   public void start(BundleContext context) throws Exception {
1143     super.start(context);
1144
1145     //          JavaCore.start(this, context);
1146     final JavaModelManager manager = JavaModelManager.getJavaModelManager();
1147     try {
1148       manager.configurePluginDebugOptions();
1149
1150       // request state folder creation (workaround 19885)
1151       //      JavaCore.getPlugin().getStateLocation();
1152       getStateLocation();
1153       // retrieve variable values
1154       PHPeclipsePlugin.getDefault().getPluginPreferences().addPropertyChangeListener(
1155           new JavaModelManager.PluginPreferencesListener());
1156       //                        manager.loadVariablesAndContainers();
1157
1158       final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1159       workspace.addResourceChangeListener(manager.deltaState, IResourceChangeEvent.PRE_BUILD | IResourceChangeEvent.POST_BUILD
1160           | IResourceChangeEvent.POST_CHANGE | IResourceChangeEvent.PRE_DELETE | IResourceChangeEvent.PRE_CLOSE);
1161
1162       //                startIndexing();
1163       ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager);
1164
1165       // process deltas since last activated in indexer thread so that indexes are up-to-date.
1166       // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=38658
1167       Job processSavedState = new Job(Util.bind("savedState.jobName")) { //$NON-NLS-1$
1168         protected IStatus run(IProgressMonitor monitor) {
1169           try {
1170             // add save participant and process delta atomically
1171             // see https://bugs.eclipse.org/bugs/show_bug.cgi?id=59937
1172             workspace.run(new IWorkspaceRunnable() {
1173               public void run(IProgressMonitor progress) throws CoreException {
1174                 ISavedState savedState = workspace.addSaveParticipant(PHPeclipsePlugin.this, manager);
1175                 if (savedState != null) {
1176                   // the event type coming from the saved state is always POST_AUTO_BUILD
1177                   // force it to be POST_CHANGE so that the delta processor can handle it
1178                   manager.deltaState.getDeltaProcessor().overridenEventType = IResourceChangeEvent.POST_CHANGE;
1179                   savedState.processResourceChangeEvents(manager.deltaState);
1180                 }
1181               }
1182             }, monitor);
1183           } catch (CoreException e) {
1184             return e.getStatus();
1185           }
1186           return Status.OK_STATUS;
1187         }
1188       };
1189       processSavedState.setSystem(true);
1190       processSavedState.setPriority(Job.SHORT); // process asap
1191       processSavedState.schedule();
1192     } catch (RuntimeException e) {
1193       manager.shutdown();
1194       throw e;
1195     }
1196
1197     registerAdapters();
1198
1199     //  if (USE_WORKING_COPY_OWNERS) {
1200     WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1201       public IBuffer createBuffer(ICompilationUnit workingCopy) {
1202         ICompilationUnit original = workingCopy.getPrimary();
1203         IResource resource = original.getResource();
1204         if (resource instanceof IFile)
1205           return new DocumentAdapter(workingCopy, (IFile) resource);
1206         return DocumentAdapter.NULL;
1207       }
1208     });
1209     //  }
1210
1211     installPreferenceStoreBackwardsCompatibility();
1212
1213   }
1214
1215   //    registerAdapters();
1216   //
1217   //     // externalTools.startUp();
1218   //    getStandardDisplay().asyncExec(new Runnable() {
1219   //      public void run() {
1220   //        //initialize the variable context manager
1221   //        VariableContextManager.getDefault();
1222   //      }
1223   //    });
1224   //
1225   //    // if (USE_WORKING_COPY_OWNERS) {
1226   //    WorkingCopyOwner.setPrimaryBufferProvider(new WorkingCopyOwner() {
1227   //      public IBuffer createBuffer(ICompilationUnit workingCopy) {
1228   //        ICompilationUnit original = workingCopy.getPrimary();
1229   //        IResource resource = original.getResource();
1230   //        if (resource instanceof IFile)
1231   //          return new DocumentAdapter(workingCopy, (IFile) resource);
1232   //        return DocumentAdapter.NULL;
1233   //      }
1234   //    });
1235   //    // }
1236
1237   //    installPreferenceStoreBackwardsCompatibility();
1238
1239   //            AllTypesCache.initialize();
1240
1241   // Initialize AST provider
1242   //            getASTProvider();
1243   //  }
1244
1245   //  public void startup() throws CoreException {
1246   //    super.startup();
1247   //    // begin JavaCore.startup();
1248   //    JavaModelManager manager = JavaModelManager.getJavaModelManager();
1249   //    try {
1250   //      manager.configurePluginDebugOptions();
1251   //      // request state folder creation (workaround 19885)
1252   //      // JavaCore.getPlugin().getStateLocation();
1253   //      getStateLocation();
1254   //      // retrieve variable values
1255   //      //
1256   // JavaCore.getPlugin().getPluginPreferences().addPropertyChangeListener(new
1257   //      // JavaModelManager.PluginPreferencesListener());
1258   //      getPluginPreferences().addPropertyChangeListener(
1259   //          new JavaModelManager.PluginPreferencesListener());
1260   //      // TODO temp-del
1261   //      // manager.loadVariablesAndContainers();
1262   //      final IWorkspace workspace = ResourcesPlugin.getWorkspace();
1263   //            workspace.addResourceChangeListener(
1264   //                    manager.deltaState,
1265   //                    IResourceChangeEvent.PRE_BUILD
1266   //                            | IResourceChangeEvent.POST_BUILD
1267   //                            | IResourceChangeEvent.POST_CHANGE
1268   //                            | IResourceChangeEvent.PRE_DELETE
1269   //                            | IResourceChangeEvent.PRE_CLOSE);
1270   //      // startIndexing();
1271   //      workspace.addSaveParticipant(PHPeclipsePlugin.getDefault(), manager);
1272   //    } catch (CoreException e) {
1273   //    } catch (RuntimeException e) {
1274   //      manager.shutdown();
1275   //      throw e;
1276   //    }
1277   //    // end JavaCore.startup();
1278   //    IAdapterManager platformManager = Platform.getAdapterManager();
1279   //    platformManager.registerAdapters(new PHPElementAdapterFactory(),
1280   //        PHPElement.class);
1281   //    platformManager.registerAdapters(new ResourceAdapterFactory(),
1282   //        IResource.class);
1283   //    // externalTools.startUp();
1284   //    getStandardDisplay().asyncExec(new Runnable() {
1285   //      public void run() {
1286   //        //initialize the variable context manager
1287   //        VariableContextManager.getDefault();
1288   //      }
1289   //    });
1290   //  }
1291
1292   private void registerAdapters() {
1293     fJavaElementAdapterFactory = new JavaElementAdapterFactory();
1294     //          fMarkerAdapterFactory= new MarkerAdapterFactory();
1295     //          fEditorInputAdapterFactory= new EditorInputAdapterFactory();
1296     fResourceAdapterFactory = new ResourceAdapterFactory();
1297     //          fLogicalPackageAdapterFactory= new LogicalPackageAdapterFactory();
1298
1299     IAdapterManager manager = Platform.getAdapterManager();
1300     manager.registerAdapters(fJavaElementAdapterFactory, IJavaElement.class);
1301     //          manager.registerAdapters(fMarkerAdapterFactory, IMarker.class);
1302     //          manager.registerAdapters(fEditorInputAdapterFactory, IEditorInput.class);
1303     manager.registerAdapters(fResourceAdapterFactory, IResource.class);
1304     //          manager.registerAdapters(fLogicalPackageAdapterFactory,
1305     // LogicalPackage.class);
1306   }
1307
1308   private void unregisterAdapters() {
1309     IAdapterManager manager = Platform.getAdapterManager();
1310     manager.unregisterAdapters(fJavaElementAdapterFactory);
1311     //          manager.unregisterAdapters(fMarkerAdapterFactory);
1312     //          manager.unregisterAdapters(fEditorInputAdapterFactory);
1313     manager.unregisterAdapters(fResourceAdapterFactory);
1314     //          manager.unregisterAdapters(fLogicalPackageAdapterFactory);
1315   }
1316
1317   /**
1318    * Returns a combined preference store, this store is read-only.
1319    *
1320    * @return the combined preference store
1321    *
1322    * @since 3.0
1323    */
1324   public IPreferenceStore getCombinedPreferenceStore() {
1325     if (fCombinedPreferenceStore == null) {
1326       IPreferenceStore generalTextStore = EditorsUI.getPreferenceStore();
1327       fCombinedPreferenceStore = new ChainedPreferenceStore(new IPreferenceStore[] {
1328           getPreferenceStore(),
1329           new PreferencesAdapter(PHPeclipsePlugin.getDefault().getPluginPreferences()),
1330           generalTextStore });
1331     }
1332     return fCombinedPreferenceStore;
1333   }
1334
1335   public synchronized IBufferFactory getBufferFactory() {
1336     if (fBufferFactory == null)
1337       fBufferFactory = new CustomBufferFactory();
1338     return fBufferFactory;
1339   }
1340
1341   /**
1342    * Returns the registry of the extensions to the <code>net.sourceforge.phpdt.ui.javaFoldingStructureProvider</code> extension
1343    * point.
1344    *
1345    * @return the registry of contributed <code>IJavaFoldingStructureProvider</code>
1346    * @since 3.0
1347    */
1348   public synchronized JavaFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() {
1349     if (fFoldingStructureProviderRegistry == null)
1350       fFoldingStructureProviderRegistry = new JavaFoldingStructureProviderRegistry();
1351     return fFoldingStructureProviderRegistry;
1352   }
1353
1354   /**
1355    * Runs the given action as an atomic Java model operation.
1356    * <p>
1357    * After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just
1358    * transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java
1359    * elements and only have element changed event notifications reported at the end of the entire batch.
1360    * </p>
1361    * <p>
1362    * If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single
1363    * element changed event describing the net effect of all changes done to java elements by the action.
1364    * </p>
1365    * <p>
1366    * If this method is called in the dynamic scope of another such call, this method simply runs the action.
1367    * </p>
1368    *
1369    * @param action
1370    *          the action to perform
1371    * @param monitor
1372    *          a progress monitor, or <code>null</code> if progress reporting and cancellation are not desired
1373    * @exception CoreException
1374    *              if the operation failed.
1375    * @since 2.1
1376    */
1377   public static void run(IWorkspaceRunnable action, IProgressMonitor monitor) throws CoreException {
1378     run(action, ResourcesPlugin.getWorkspace().getRoot(), monitor);
1379   }
1380
1381   /**
1382    * Runs the given action as an atomic Java model operation.
1383    * <p>
1384    * After running a method that modifies java elements, registered listeners receive after-the-fact notification of what just
1385    * transpired, in the form of a element changed event. This method allows clients to call a number of methods that modify java
1386    * elements and only have element changed event notifications reported at the end of the entire batch.
1387    * </p>
1388    * <p>
1389    * If this method is called outside the dynamic scope of another such call, this method runs the action and then reports a single
1390    * element changed event describing the net effect of all changes done to java elements by the action.
1391    * </p>
1392    * <p>
1393    * If this method is called in the dynamic scope of another such call, this method simply runs the action.
1394    * </p>
1395    * <p>
1396    * The supplied scheduling rule is used to determine whether this operation can be run simultaneously with workspace changes in
1397    * other threads. See <code>IWorkspace.run(...)</code> for more details.
1398    * </p>
1399    *
1400    * @param action
1401    *          the action to perform
1402    * @param rule
1403    *          the scheduling rule to use when running this operation, or <code>null</code> if there are no scheduling restrictions
1404    *          for this operation.
1405    * @param monitor
1406    *          a progress monitor, or <code>null</code> if progress reporting and cancellation are not desired
1407    * @exception CoreException
1408    *              if the operation failed.
1409    * @since 3.0
1410    */
1411   public static void run(IWorkspaceRunnable action, ISchedulingRule rule, IProgressMonitor monitor) throws CoreException {
1412     IWorkspace workspace = ResourcesPlugin.getWorkspace();
1413     if (workspace.isTreeLocked()) {
1414       new BatchOperation(action).run(monitor);
1415     } else {
1416       // use IWorkspace.run(...) to ensure that a build will be done in
1417       // autobuild mode
1418       workspace.run(new BatchOperation(action), rule, IWorkspace.AVOID_UPDATE, monitor);
1419     }
1420   }
1421
1422   /**
1423    * Returns the template context type registry for the java plugin.
1424    *
1425    * @return the template context type registry for the java plugin
1426    * @since 3.0
1427    */
1428   public ContextTypeRegistry getTemplateContextRegistry() {
1429     if (fContextTypeRegistry == null) {
1430       fContextTypeRegistry = new ContributionContextTypeRegistry();
1431
1432       fContextTypeRegistry.addContextType(new JavaContextType());
1433       fContextTypeRegistry.addContextType(new JavaDocContextType());
1434       fContextTypeRegistry.addContextType(new HTMLContextType());
1435     }
1436
1437     return fContextTypeRegistry;
1438   }
1439
1440   /**
1441    * Returns the template store for the java editor templates.
1442    *
1443    * @return the template store for the java editor templates
1444    * @since 3.0
1445    */
1446   public TemplateStore getTemplateStore() {
1447     if (fTemplateStore == null) {
1448       //                        boolean alreadyMigrated= getPreferenceStore().getBoolean(TEMPLATES_MIGRATION_KEY);
1449       //                        if (alreadyMigrated)
1450       fTemplateStore = new ContributionTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY);
1451       //                        else {
1452       //                                fTemplateStore= new CompatibilityTemplateStore(getTemplateContextRegistry(), getPreferenceStore(), TEMPLATES_KEY,
1453       // Templates.getInstance());
1454       //                                getPreferenceStore().setValue(TEMPLATES_MIGRATION_KEY, true);
1455       //                        }
1456
1457       try {
1458         fTemplateStore.load();
1459       } catch (IOException e) {
1460         log(e);
1461       }
1462     }
1463
1464     return fTemplateStore;
1465   }
1466
1467   /**
1468    * Returns the template context type registry for the code generation templates.
1469    *
1470    * @return the template context type registry for the code generation templates
1471    * @since 3.0
1472    */
1473   public ContextTypeRegistry getCodeTemplateContextRegistry() {
1474     if (fCodeTemplateContextTypeRegistry == null) {
1475       fCodeTemplateContextTypeRegistry = new ContributionContextTypeRegistry();
1476
1477       CodeTemplateContextType.registerContextTypes(fCodeTemplateContextTypeRegistry);
1478     }
1479
1480     return fCodeTemplateContextTypeRegistry;
1481   }
1482
1483   /**
1484    * Returns the template store for the code generation templates.
1485    *
1486    * @return the template store for the code generation templates
1487    * @since 3.0
1488    */
1489   public TemplateStore getCodeTemplateStore() {
1490     if (fCodeTemplateStore == null) {
1491       //                        boolean alreadyMigrated= getPreferenceStore().getBoolean(CODE_TEMPLATES_MIGRATION_KEY);
1492       //                        if (alreadyMigrated)
1493       fCodeTemplateStore = new ContributionTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(), CODE_TEMPLATES_KEY);
1494       //                        else {
1495       //                                fCodeTemplateStore= new CompatibilityTemplateStore(getCodeTemplateContextRegistry(), getPreferenceStore(),
1496       // CODE_TEMPLATES_KEY, CodeTemplates.getInstance());
1497       //                                getPreferenceStore().setValue(CODE_TEMPLATES_MIGRATION_KEY, true);
1498       //                        }
1499
1500       try {
1501         fCodeTemplateStore.load();
1502       } catch (IOException e) {
1503         log(e);
1504       }
1505
1506       // compatibility / bug fixing code for duplicated templates
1507       // TODO remove for 3.0
1508       //                        CompatibilityTemplateStore.pruneDuplicates(fCodeTemplateStore, true);
1509     }
1510
1511     return fCodeTemplateStore;
1512   }
1513 }