new icon for "defines" in code completion
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / PHPeclipsePlugin.java
index cb16be2..8ab0b94 100644 (file)
@@ -11,6 +11,11 @@ Contributors:
 **********************************************************************/
 package net.sourceforge.phpeclipse;
 
+import java.io.File;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Iterator;
+
 import net.sourceforge.phpdt.externaltools.internal.model.ColorManager;
 import net.sourceforge.phpdt.externaltools.internal.model.ExternalToolsPlugin;
 import net.sourceforge.phpdt.externaltools.internal.model.VariableContextManager;
@@ -18,6 +23,10 @@ import net.sourceforge.phpdt.internal.ui.preferences.TemplatePreferencePage;
 import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry;
 import net.sourceforge.phpdt.ui.PreferenceConstants;
 import net.sourceforge.phpdt.ui.text.JavaTextTools;
+import net.sourceforge.phpeclipse.builder.ExternalEditorInput;
+import net.sourceforge.phpeclipse.builder.ExternalStorageDocumentProvider;
+import net.sourceforge.phpeclipse.builder.FileStorage;
+import net.sourceforge.phpeclipse.builder.IdentifierIndexManager;
 import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider;
 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
@@ -27,6 +36,7 @@ import net.sourceforge.phpeclipse.resourcesview.ResourceAdapterFactory;
 
 import org.eclipse.core.boot.BootLoader;
 import org.eclipse.core.resources.IFile;
+import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IWorkspace;
 import org.eclipse.core.resources.ResourcesPlugin;
@@ -40,22 +50,30 @@ import org.eclipse.core.runtime.Platform;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.preference.PreferenceConverter;
+import org.eclipse.jface.text.BadLocationException;
+import org.eclipse.jface.text.IDocument;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
+import org.eclipse.ui.IEditorDescriptor;
+import org.eclipse.ui.IEditorInput;
+import org.eclipse.ui.IEditorPart;
+import org.eclipse.ui.IEditorRegistry;
+import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchWindow;
+import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
+import org.eclipse.ui.texteditor.IDocumentProvider;
+import org.eclipse.ui.texteditor.ITextEditor;
 
 /**
  * The main plugin class to be used in the desktop.
  */
 public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceConstants {
-
   /**
    * The id of the PHP plugin (value <code>"net.sourceforge.phpeclipse"</code>).
    */
   public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$
-  public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
 
   /** 
    * id of builder - matches plugin.xml (concatenate pluginid.builderid) 
@@ -63,27 +81,10 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
   public static final String BUILDER_INDEX_ID = PLUGIN_ID + ".indexbuilder";
   public static final String BUILDER_PARSER_ID = PLUGIN_ID + ".parserbuilder";
 
-  // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
-  public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID + ".ui.CodingActionSet"; //$NON-NLS-1$
-
-  public static final String PHPPARSER_NEW = "test.PHPParser";
-  public static final String PHPPARSER_ORIGINAL = "net.sourceforge.phpdt.internal.compiler.parser.Parser";
-
-  /** Change this if you want to switch PHP Parser. */
-  public static final String PHPPARSER = PHPPARSER_ORIGINAL;
-
-  //The shared instance.
-  private static PHPeclipsePlugin plugin;
+  /** General debug flag*/
+  public static final boolean DEBUG = false;
 
   private static ExternalToolsPlugin externalTools;
-  //Resource bundle.
-  //private ResourceBundle resourceBundle;
-
-  private ImageDescriptorRegistry fImageDescriptorRegistry;
-  private PHPDocumentProvider fCompilationUnitDocumentProvider;
-  private IFile fLastEditorFile = null;
-
-  private JavaTextTools fJavaTextTools;
 
   /**
   * The Java virtual machine that we are running on.
@@ -102,17 +103,37 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
   /** MRJ 3.1 */
   private static final int MRJ_3_1 = 4;
 
-  /** Windows NT  */
-  private static final int WINDOWS_NT = 5;
+  /** JVM constant for any other platform */
+  private static final int OTHER = -1;
+
+  // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
+  public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID + ".ui.CodingActionSet"; //$NON-NLS-1$
+  public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
+
+  public static final String PHPPARSER_ORIGINAL = "net.sourceforge.phpdt.internal.compiler.parser.Parser";
+
+  public static final String PHPPARSER_NEW = "test.PHPParser";
+
+  /** Change this if you want to switch PHP Parser. */
+  public static final String PHPPARSER = PHPPARSER_ORIGINAL;
+
+  //The shared instance.
+  private static PHPeclipsePlugin plugin;
 
   /** Windows 9x  */
   private static final int WINDOWS_9x = 6;
 
-  /** JVM constant for any other platform */
-  private static final int OTHER = -1;
+  /** Windows NT  */
+  private static final int WINDOWS_NT = 5;
+  private PHPDocumentProvider fCompilationUnitDocumentProvider;
+  //Resource bundle.
+  //private ResourceBundle resourceBundle;
 
-  /** General debug flag*/
-  public static final boolean DEBUG = false;
+  private ImageDescriptorRegistry fImageDescriptorRegistry;
+  private HashMap fIndexManagerMap = new HashMap();
+
+  private JavaTextTools fJavaTextTools;
+  private IFile fLastEditorFile = null;
   /**
    * The constructor.
    */
@@ -128,63 +149,50 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     //    }
   }
 
-  public static ImageDescriptorRegistry getImageDescriptorRegistry() {
-    return getDefault().internalGetImageDescriptorRegistry();
+  public static IWorkbenchPage getActivePage() {
+    return getDefault().internalGetActivePage();
   }
 
-  private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
-    if (fImageDescriptorRegistry == null)
-      fImageDescriptorRegistry = new ImageDescriptorRegistry();
-    return fImageDescriptorRegistry;
-  }
-  // @TODO: refactor this into a better method name !
-  public synchronized PHPDocumentProvider getCompilationUnitDocumentProvider() {
-    if (fCompilationUnitDocumentProvider == null)
-      fCompilationUnitDocumentProvider = new PHPDocumentProvider();
-    return fCompilationUnitDocumentProvider;
+  public static Shell getActiveWorkbenchShell() {
+    return getActiveWorkbenchWindow().getShell();
   }
 
-  private static void setJVM() {
-    String osName = System.getProperty("os.name");
-
-    if (osName.startsWith("Mac OS")) {
-      String mrjVersion = System.getProperty("mrj.version");
-      String majorMRJVersion = mrjVersion.substring(0, 3);
-      jvm = OTHER;
-      try {
-
-        double version = Double.valueOf(majorMRJVersion).doubleValue();
-
-        if (version == 2) {
-          jvm = MRJ_2_0;
-        } else if (version >= 2.1 && version < 3) {
-          jvm = MRJ_2_1;
-        } else if (version == 3.0) {
-          jvm = MRJ_3_0;
-        } else if (version >= 3.1) {
-          jvm = MRJ_3_1;
-        }
-
-      } catch (NumberFormatException nfe) {
+  public static IWorkbenchWindow getActiveWorkbenchWindow() {
+    return getDefault().getWorkbench().getActiveWorkbenchWindow();
+  }
+  /**
+   * Returns the shared instance.
+   */
+  public static PHPeclipsePlugin getDefault() {
+    return plugin;
+  }
 
-      }
+  public static ImageDescriptorRegistry getImageDescriptorRegistry() {
+    return getDefault().internalGetImageDescriptorRegistry();
+  }
 
-    } else if (osName.startsWith("Windows")) {
-      if (osName.indexOf("9") != -1) {
-        jvm = WINDOWS_9x;
-      } else {
-        jvm = WINDOWS_NT;
-      }
-    }
+  static IPath getInstallLocation() {
+    return new Path(getDefault().getDescriptor().getInstallURL().getFile());
   }
   public static int getJVM() {
     return jvm;
   }
+
+  public static String getPluginId() {
+    return getDefault().getDescriptor().getUniqueIdentifier();
+  }
+
   /**
-   * Returns the shared instance.
+   * Returns the standard display to be used. The method first checks, if
+   * the thread calling this method has an associated display. If so, this
+   * display is returned. Otherwise the method returns the default display.
    */
-  public static PHPeclipsePlugin getDefault() {
-    return plugin;
+  public static Display getStandardDisplay() {
+    Display display = Display.getCurrent();
+    if (display == null) {
+      display = Display.getDefault();
+    }
+    return display;
   }
 
   //  public static ExternalToolsPlugin getExternalTools() {
@@ -197,31 +205,8 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     return ResourcesPlugin.getWorkspace();
   }
 
-  public static IWorkbenchPage getActivePage() {
-    return getDefault().internalGetActivePage();
-  }
-
-  private IWorkbenchPage internalGetActivePage() {
-    IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
-    if (window != null)
-      return window.getActivePage();
-    return null;
-  }
-
-  public static IWorkbenchWindow getActiveWorkbenchWindow() {
-    return getDefault().getWorkbench().getActiveWorkbenchWindow();
-  }
-
-  public static Shell getActiveWorkbenchShell() {
-    return getActiveWorkbenchWindow().getShell();
-  }
-
-  public static String getPluginId() {
-    return getDefault().getDescriptor().getUniqueIdentifier();
-  }
-
-  public static void log(IStatus status) {
-    getDefault().getLog().log(status);
+  public static boolean isDebug() {
+    return getDefault().isDebugging();
   }
 
   //  public static void logErrorMessage(String message) {
@@ -246,16 +231,69 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null);
     log(status);
   }
+
+  public static void log(IStatus status) {
+    getDefault().getLog().log(status);
+  }
   public static void log(Throwable e) {
     log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$
   }
 
-  public static boolean isDebug() {
-    return getDefault().isDebugging();
+  private static void setJVM() {
+    String osName = System.getProperty("os.name");
+
+    if (osName.startsWith("Mac OS")) {
+      String mrjVersion = System.getProperty("mrj.version");
+      String majorMRJVersion = mrjVersion.substring(0, 3);
+      jvm = OTHER;
+      try {
+
+        double version = Double.valueOf(majorMRJVersion).doubleValue();
+
+        if (version == 2) {
+          jvm = MRJ_2_0;
+        } else if (version >= 2.1 && version < 3) {
+          jvm = MRJ_2_1;
+        } else if (version == 3.0) {
+          jvm = MRJ_3_0;
+        } else if (version >= 3.1) {
+          jvm = MRJ_3_1;
+        }
+
+      } catch (NumberFormatException nfe) {
+
+      }
+
+    } else if (osName.startsWith("Windows")) {
+      if (osName.indexOf("9") != -1) {
+        jvm = WINDOWS_9x;
+      } else {
+        jvm = WINDOWS_NT;
+      }
+    }
   }
 
-  static IPath getInstallLocation() {
-    return new Path(getDefault().getDescriptor().getInstallURL().getFile());
+  // TODO: refactor this into a better method name !
+  public synchronized PHPDocumentProvider getCompilationUnitDocumentProvider() {
+    if (fCompilationUnitDocumentProvider == null)
+      fCompilationUnitDocumentProvider = new PHPDocumentProvider();
+    return fCompilationUnitDocumentProvider;
+  }
+
+  /**
+   * Get the identifier index manager for the given project
+   * 
+   * @param iProject the current project
+   * @return
+   */
+  public IdentifierIndexManager getIndexManager(IProject iProject) {
+    String indexFilename = iProject.getLocation() + File.separator + "project.index";
+    IdentifierIndexManager indexManager = (IdentifierIndexManager) fIndexManagerMap.get(indexFilename);
+    if (indexManager == null) {
+      indexManager = new IdentifierIndexManager(indexFilename);
+      fIndexManagerMap.put(indexFilename, indexManager);
+    }
+    return indexManager;
   }
 
   public synchronized JavaTextTools getJavaTextTools() {
@@ -264,6 +302,10 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     return fJavaTextTools;
   }
 
+  public IFile getLastEditorFile() {
+    return fLastEditorFile;
+  }
+
   /**
    * Returns the string from the plugin's resource bundle,
    * or 'key' if not found.
@@ -299,7 +341,7 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     } else if (windowsSystem.equals(BootLoader.WS_WIN32)) {
       store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}");
     } else if (windowsSystem.equals(BootLoader.WS_CARBON)) {
-       // TODO How do we start Safari on Mac OS X ?
+      // TODO How do we start Safari on Mac OS X ?
       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
     } else {
       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
@@ -354,6 +396,12 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
     PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING);
     PreferenceConverter.setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
+    
+               PreferenceConverter.setDefault(store, PHPDOC_KEYWORD, PHPColorProvider.PHPDOC_KEYWORD);
+               PreferenceConverter.setDefault(store, PHPDOC_TAG, PHPColorProvider.PHPDOC_TAG);
+               PreferenceConverter.setDefault(store, PHPDOC_LINK, PHPColorProvider.PHPDOC_LINK);
+               PreferenceConverter.setDefault(store, PHPDOC_DEFAULT, PHPColorProvider.PHPDOC_DEFAULT);
+                       
     //    PreferenceConverter.setDefault(
     //      store,
     //      PHP_EDITOR_BACKGROUND,
@@ -412,17 +460,150 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     externalTools.initializeDefaultPreferences(store);
   }
 
+  private IWorkbenchPage internalGetActivePage() {
+    IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
+    if (window != null)
+      return window.getActivePage();
+    return null;
+  }
+
+  private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
+    if (fImageDescriptorRegistry == null)
+      fImageDescriptorRegistry = new ImageDescriptorRegistry();
+    return fImageDescriptorRegistry;
+  }
   /**
-   * Returns the standard display to be used. The method first checks, if
-   * the thread calling this method has an associated display. If so, this
-   * display is returned. Otherwise the method returns the default display.
+       * Open a file in the Workbench that may or may not exist in the workspace.
+       * Must be run on the UI thread.
+       * @param filename
+       * @throws CoreException
+       */
+  public ITextEditor openFileInTextEditor(String filename) throws CoreException {
+
+    // reject directories
+    if (new File(filename).isDirectory())
+      return null;
+
+    IWorkbench workbench = PlatformUI.getWorkbench();
+    IWorkbenchWindow window = workbench.getWorkbenchWindows()[0];
+    IWorkbenchPage page = window.getActivePage();
+    IPath path = new Path(filename);
+
+    // If the file exists in the workspace, open it
+    IFile file = getWorkspace().getRoot().getFileForLocation(path);
+    IEditorPart editor;
+    ITextEditor textEditor;
+    if (file != null && file.exists()) {
+      editor = page.openEditor(file);
+      textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
+    } else {
+      // Otherwise open the stream directly
+      if (page == null)
+        return null;
+      FileStorage storage = new FileStorage(path);
+      IEditorRegistry registry = getWorkbench().getEditorRegistry();
+      IEditorDescriptor desc = registry.getDefaultEditor(filename);
+      if (desc == null) {
+        desc = registry.getDefaultEditor();
+      }
+      IEditorInput input = new ExternalEditorInput(storage);
+      editor = page.openEditor(input, desc.getId());
+      textEditor = (ITextEditor) editor.getAdapter(ITextEditor.class);
+
+      // If the storage provider is not ours, we can't guarantee read/write.
+      if (textEditor != null) {
+        IDocumentProvider documentProvider = textEditor.getDocumentProvider();
+        if (!(documentProvider instanceof ExternalStorageDocumentProvider)) {
+          storage.setReadOnly();
+        }
+      }
+    }
+    return textEditor;
+  }
+  /**
+       * Open a file in the Workbench that may or may not exist in the workspace.
+       * Must be run on the UI thread.
+       * @param filename
+       * @param line
+       * @throws CoreException
+       */
+  public void openFileAndGotoLine(String filename, int line) throws CoreException {
+
+    ITextEditor textEditor = openFileInTextEditor(filename);
+    if (textEditor != null) {
+      // If a line number was given, go to it
+      if (line > 0) {
+        try {
+          line--; // document is 0 based
+          IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
+          textEditor.selectAndReveal(document.getLineOffset(line), document.getLineLength(line));
+
+        } catch (BadLocationException e) {
+          // invalid text position -> do nothing
+        }
+      }
+    }
+  }
+
+  /**
+       * Open a file in the Workbench that may or may not exist in the workspace.
+       * Must be run on the UI thread.
+       * @param filename
+       * @param offset
+       * @throws CoreException
+       */
+  public void openFileAndGotoOffset(String filename, int offset, int length) throws CoreException {
+
+    ITextEditor textEditor = openFileInTextEditor(filename);
+    if (textEditor != null) {
+      // If a line number was given, go to it
+      if (offset >= 0) {
+        IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
+        textEditor.selectAndReveal(offset, length);
+      }
+    }
+  }
+
+  public void openFileAndFindString(String filename, String findString) throws CoreException {
+
+    ITextEditor textEditor = openFileInTextEditor(filename);
+    if (textEditor != null) {
+      //               If a string was given, go to it
+      if (findString != null) {
+        try {
+          IDocument document = textEditor.getDocumentProvider().getDocument(textEditor.getEditorInput());
+          int offset = document.search(0, findString, true, false, true);
+          textEditor.selectAndReveal(offset, findString.length());
+
+        } catch (BadLocationException e) {
+          // invalid text position -> do nothing
+        }
+
+      }
+    }
+  }
+  public void setLastEditorFile(IFile textEditor) {
+    this.fLastEditorFile = textEditor;
+  }
+
+  /**
+   * @see org.eclipse.ui.plugin.AbstractUIPlugin#shutdown()
    */
-  public static Display getStandardDisplay() {
-    Display display = Display.getCurrent();
-    if (display == null) {
-      display = Display.getDefault();
+  public void shutdown() throws CoreException {
+    super.shutdown();
+
+    //  externalTools.shutDown();
+    ColorManager.getDefault().dispose();
+
+    // save the information from the php index files if necessary
+    Collection collection = fIndexManagerMap.values();
+    Iterator iterator = collection.iterator();
+    IdentifierIndexManager indexManager = null;
+    while (iterator.hasNext()) {
+      indexManager = (IdentifierIndexManager) iterator.next();
+      indexManager.writeFile();
     }
-    return display;
+
   }
 
   public void startup() throws CoreException {
@@ -439,19 +620,4 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     });
   }
 
-  /**
-   * @see org.eclipse.core.runtime.Plugin#shutdown()
-   */
-  public void shutdown() throws CoreException {
-    //  externalTools.shutDown();
-    ColorManager.getDefault().dispose();
-  }
-
-  public void setLastEditorFile(IFile textEditor) {
-    this.fLastEditorFile = textEditor;
-  }
-
-  public IFile getLastEditorFile() {
-    return fLastEditorFile;
-  }
 }
\ No newline at end of file