some refactoring in the code analysis
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / PHPeclipsePlugin.java
index e120ce4..7f027b7 100644 (file)
@@ -11,13 +11,22 @@ Contributors:
 **********************************************************************/
 package net.sourceforge.phpeclipse;
 
-import java.util.MissingResourceException;
-import java.util.ResourceBundle;
-
+import net.sourceforge.phpdt.externaltools.internal.model.ColorManager;
+import net.sourceforge.phpdt.externaltools.internal.model.ExternalToolsPlugin;
+import net.sourceforge.phpdt.externaltools.internal.model.VariableContextManager;
+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.phpeditor.PHPDocumentProvider;
+import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
-import net.sourceforge.phpeclipse.resourcesview.*;
+import net.sourceforge.phpeclipse.resourcesview.PHPElement;
+import net.sourceforge.phpeclipse.resourcesview.PHPElementAdapterFactory;
+import net.sourceforge.phpeclipse.resourcesview.ResourceAdapterFactory;
 
+import org.eclipse.core.boot.BootLoader;
+import org.eclipse.core.resources.IFile;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IWorkspace;
 import org.eclipse.core.resources.ResourcesPlugin;
@@ -31,6 +40,7 @@ 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.swt.widgets.Display;
 import org.eclipse.swt.widgets.Shell;
 import org.eclipse.ui.IWorkbenchPage;
 import org.eclipse.ui.IWorkbenchWindow;
@@ -40,32 +50,36 @@ import org.eclipse.ui.plugin.AbstractUIPlugin;
  * The main plugin class to be used in the desktop.
  */
 public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceConstants {
-  //   public static final String LOCALHOST_PREF = "_localhost";
-  //   public static final String DOCUMENTROOT_PREF = "_documentroot";
-  //   public static final String USE_EXTERNAL_BROWSER_PREF = "_use_external_browser";
-  //   public static final String EXTERNAL_BROWSER_PREF = "_external_browser";
-  //   public static final String MYSQL_PREF = "_my_sql";
-  //   public static final String APACHE_START_PREF = "_apache_start";
-  //   public static final String APACHE_STOP_PREF = "_apache_stop";
-  //   public static final String APACHE_RESTART_PREF = "_apache_restart";
-  //  public static final String SHOW_OUTPUT_IN_CONSOLE = "_sho_output_in_console";
-  //  public static final String EXTERNAL_PARSER_PREF = "_external_parser";
 
   /**
    * 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";
-  public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + ".resourcesview.ViewPHPResources"; //$NON-NLS-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 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;
+
+  private static ExternalToolsPlugin externalTools;
   //Resource bundle.
-  private ResourceBundle resourceBundle;
+  //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.  
+  * The Java virtual machine that we are running on.
   */
   private static int jvm;
 
@@ -89,6 +103,9 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
 
   /** JVM constant for any other platform */
   private static final int OTHER = -1;
+
+  /** General debug flag*/
+  public static final boolean DEBUG = false;
   /**
    * The constructor.
    */
@@ -96,21 +113,31 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     super(descriptor);
     plugin = this;
     setJVM();
-    try {
-      resourceBundle = ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
-    } catch (MissingResourceException x) {
-      resourceBundle = null;
-    }
+    externalTools = new ExternalToolsPlugin();
+    //    try {
+    //      resourceBundle = ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
+    //    } catch (MissingResourceException x) {
+    //      resourceBundle = null;
+    //    }
+  }
+
+  public static ImageDescriptorRegistry getImageDescriptorRegistry() {
+    return getDefault().internalGetImageDescriptorRegistry();
   }
 
+  private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
+    if (fImageDescriptorRegistry == null)
+      fImageDescriptorRegistry = new ImageDescriptorRegistry();
+    return fImageDescriptorRegistry;
+  }
   // @TODO: refactor this into a better method name !
-  public PHPDocumentProvider getCompilationUnitDocumentProvider() {
+  public synchronized PHPDocumentProvider getCompilationUnitDocumentProvider() {
     if (fCompilationUnitDocumentProvider == null)
       fCompilationUnitDocumentProvider = new PHPDocumentProvider();
     return fCompilationUnitDocumentProvider;
   }
 
-  public static void setJVM() {
+  private static void setJVM() {
     String osName = System.getProperty("os.name");
 
     if (osName.startsWith("Mac OS")) {
@@ -153,6 +180,9 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     return plugin;
   }
 
+  //  public static ExternalToolsPlugin getExternalTools() {
+  //    return externalTools;
+  //  }
   /**
    * Returns the workspace instance.
    */
@@ -161,7 +191,14 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
   }
 
   public static IWorkbenchPage getActivePage() {
-    return getDefault().getActivePage();
+    return getDefault().internalGetActivePage();
+  }
+
+  private IWorkbenchPage internalGetActivePage() {
+    IWorkbenchWindow window = getWorkbench().getActiveWorkbenchWindow();
+    if (window != null)
+      return window.getActivePage();
+    return null;
   }
 
   public static IWorkbenchWindow getActiveWorkbenchWindow() {
@@ -187,20 +224,25 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
   //  public static void logErrorStatus(String message, IStatus status) {
   //    if (status == null) {
   //      logErrorMessage(message);
-  //      return; 
+  //      return;
   //    }
   //    MultiStatus multi= new MultiStatus(getPluginId(), JavaStatusConstants.INTERNAL_ERROR, message, null);
   //    multi.add(status);
   //    log(multi);
   //  }
-  //  
+  //
   //  public static void log(Throwable e) {
   //    log(new Status(IStatus.ERROR, getPluginId(), JavaStatusConstants.INTERNAL_ERROR, JavaUIMessages.getString("JavaPlugin.internal_error"), e)); //$NON-NLS-1$
   //  }
-  
+
+  public static void log(int severity, String message) {
+    Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null);
+    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();
   }
@@ -209,77 +251,194 @@ public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceCon
     return new Path(getDefault().getDescriptor().getInstallURL().getFile());
   }
 
+  public synchronized JavaTextTools getJavaTextTools() {
+    if (fJavaTextTools == null)
+      fJavaTextTools = new JavaTextTools(getPreferenceStore());
+    return fJavaTextTools;
+  }
+
   /**
    * Returns the string from the plugin's resource bundle,
    * or 'key' if not found.
    */
-  public static String getResourceString(String key) {
-    ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
-    try {
-      return bundle.getString(key);
-    } catch (MissingResourceException e) {
-      return key;
-    }
-  }
+  //  public static String getResourceString(String key) {
+  //    ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
+  //    try {
+  //      return bundle.getString(key);
+  //    } catch (MissingResourceException e) {
+  //      return key;
+  //    }
+  //  }
 
   /**
    * Returns the plugin's resource bundle,
    */
-  public ResourceBundle getResourceBundle() {
-    return resourceBundle;
-  }
+  //  public ResourceBundle getResourceBundle() {
+  //    return resourceBundle;
+  //  }
 
   protected void initializeDefaultPreferences(IPreferenceStore store) {
     // windows preferences:
     store.setDefault(LOCALHOST_PREF, "http://localhost");
 
+    store.setDefault(SHOW_EXTERNAL_PREVIEW_PREF, "true");
     store.setDefault(USE_EXTERNAL_BROWSER_PREF, "false");
     store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
+
+    String windowsSystem = BootLoader.getWS();
+
     if (jvm == WINDOWS_9x) {
       store.setDefault(EXTERNAL_BROWSER_PREF, "command.com /c start iexplore {0}");
-    } else if (jvm == WINDOWS_NT) {
+    } else if (windowsSystem.equals(BootLoader.WS_WIN32)) {
       store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}");
     } else {
       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
     }
-    if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) {
+    store.setDefault(DOCUMENTROOT_PREF, getWorkspace().getRoot().getLocation().toString());
+
+    //  if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) {
+    // 
+    if (windowsSystem.equals(BootLoader.WS_WIN32)) {
+      store.setDefault(PHP_RUN_PREF, "c:\\apache\\php\\php.exe");
       store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
-      store.setDefault(DOCUMENTROOT_PREF, "c:\\eclipse\\workspace");
-      store.setDefault(MYSQL_PREF, "c:\\apache\\mysql\\bin\\mysqld.exe --standalone");
-      store.setDefault(APACHE_START_PREF, "c:\\apache\\apache.exe -c \"DocumentRoot \"{0}\"\"");
-      store.setDefault(APACHE_STOP_PREF, "c:\\apache\\apache.exe -k shutdown");
-      store.setDefault(APACHE_RESTART_PREF, "c:\\apache\\apache.exe -k restart");
+      store.setDefault(MYSQL_RUN_PREF, "c:\\apache\\mysql\\bin\\mysqld-nt.exe");
+      store.setDefault(APACHE_RUN_PREF, "c:\\apache\\apache.exe");
     } else {
+      store.setDefault(PHP_RUN_PREF, "/apache/php/php");
       store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
-      store.setDefault(DOCUMENTROOT_PREF, "/eclipse/workspace");
-      store.setDefault(MYSQL_PREF, "/apache/mysql/bin/mysqld --standalone");
-      store.setDefault(APACHE_START_PREF, "/apache/apache -c \"DocumentRoot \"{0}\"\"");
-      store.setDefault(APACHE_STOP_PREF, "/apache/apache.exe -k shutdown");
-      store.setDefault(APACHE_RESTART_PREF, "/apache/apache -k restart");
+      store.setDefault(MYSQL_RUN_PREF, "/apache/mysql/bin/mysqld");
+      store.setDefault(APACHE_RUN_PREF, "/apache/apache");
     }
+    store.setDefault(MYSQL_PREF, "--standalone");
+    store.setDefault(APACHE_START_PREF, "-c \"DocumentRoot \"{0}\"\"");
+    store.setDefault(APACHE_STOP_PREF, "-k shutdown");
+    store.setDefault(APACHE_RESTART_PREF, "-k restart");
+
+    store.setDefault(MYSQL_START_BACKGROUND, "true");
+    store.setDefault(APACHE_START_BACKGROUND, "true");
+    store.setDefault(APACHE_STOP_BACKGROUND, "true");
+    store.setDefault(APACHE_RESTART_BACKGROUND, "true");
 
     store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
     store.setDefault(PHP_INTERNAL_PARSER, "false");
     store.setDefault(PHP_EXTERNAL_PARSER, "true");
-    
+
     store.setDefault(PHP_PARSE_ON_SAVE, "true");
+
+    // show line numbers:
+    //   store.setDefault(LINE_NUMBER_RULER, "false");
+    //    store.setDefault(FORMATTER_TAB_SIZE, "4");
+
     // php syntax highlighting
+    store.setDefault(PHP_USERDEF_XMLFILE, ""); //assume there is none  chooA
+
     PreferenceConverter.setDefault(store, PHP_MULTILINE_COMMENT, PHPColorProvider.MULTI_LINE_COMMENT);
     PreferenceConverter.setDefault(store, PHP_SINGLELINE_COMMENT, PHPColorProvider.SINGLE_LINE_COMMENT);
     PreferenceConverter.setDefault(store, PHP_KEYWORD, PHPColorProvider.KEYWORD);
     PreferenceConverter.setDefault(store, PHP_VARIABLE, PHPColorProvider.VARIABLE);
     PreferenceConverter.setDefault(store, PHP_FUNCTIONNAME, PHPColorProvider.FUNCTION_NAME);
-    PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING); 
+    PreferenceConverter.setDefault(store, PHP_CONSTANT, PHPColorProvider.CONSTANT);
+    PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
+    PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING);
     PreferenceConverter.setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
-    PreferenceConverter.setDefault(store, LINKED_POSITION_COLOR, PHPColorProvider.LINKED_POSITION_COLOR);
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PHP_EDITOR_BACKGROUND,
+    //      PHPColorProvider.BACKGROUND);
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      LINKED_POSITION_COLOR,
+    //      PHPColorProvider.LINKED_POSITION_COLOR);
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      LINE_NUMBER_COLOR,
+    //      PHPColorProvider.LINE_NUMBER_COLOR);
+
+    //    // set default PHPDoc colors:
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PHPDOC_KEYWORD, 
+    //      PHPColorProvider.PHPDOC_KEYWORD);
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PHPDOC_LINK, 
+    //      PHPColorProvider.PHPDOC_LINK);      
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PHPDOC_DEFAULT, 
+    //      PHPColorProvider.PHPDOC_DEFAULT);
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PHPDOC_TAG, 
+    //      PHPColorProvider.PHPDOC_TAG);
+
+    //    store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
+    //    PreferenceConverter.setDefault(
+    //      store,
+    //      PREFERENCE_COLOR_BACKGROUND,
+    //      PHPColorProvider.BACKGROUND_COLOR);
+
+    //language stuff
+    store.setDefault(RESOURCE_BUNDLE, LANGUAGE_DEFAULT);
+    store.setDefault(RESOURCE_BUNDLE_EN_GB, "true");
+    store.setDefault(RESOURCE_BUNDLE_DE, "false");
+    store.setDefault(RESOURCE_BUNDLE_FR, "false");
+    store.setDefault(RESOURCE_BUNDLE_ES, "false");
+
+    store.setDefault(PHP_OUTLINE_CLASS, "true"); //$NON-NLS-1$
+    store.setDefault(PHP_OUTLINE_FUNC, "true"); //$NON-NLS-1$
+    store.setDefault(PHP_OUTLINE_VAR, "true"); //$NON-NLS-1$
+
+    TemplatePreferencePage.initDefaults(store);
+    //this will initialize the static fields in the syntaxrdr class
+    new PHPSyntaxRdr();
+
+    PHPCore.initializeDefaultPluginPreferences();
+    PreferenceConstants.initializeDefaultValues(store);
+
+    externalTools.initializeDefaultPreferences(store);
+  }
 
+  /**
+   * 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 Display getStandardDisplay() {
+    Display display = Display.getCurrent();
+    if (display == null) {
+      display = Display.getDefault();
+    }
+    return display;
   }
-  
-    public void startup() throws CoreException {
+
+  public void startup() throws CoreException {
     super.startup();
-    IAdapterManager manager= Platform.getAdapterManager();
+    IAdapterManager manager = Platform.getAdapterManager();
     manager.registerAdapters(new PHPElementAdapterFactory(), PHPElement.class);
     manager.registerAdapters(new ResourceAdapterFactory(), IResource.class);
+    //  externalTools.startUp(); 
+    getStandardDisplay().asyncExec(new Runnable() {
+      public void run() {
+        //initialize the variable context manager
+        VariableContextManager.getDefault();
+      }
+    });
+  }
+
+  /**
+   * @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