net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/PHPeclipsePlugin.java

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