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.util.MissingResourceException;
  15 import java.util.ResourceBundle;
  16
  17 import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry;
  18 import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider;
  19 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
  20 import net.sourceforge.phpeclipse.resourcesview.PHPElement;
  21 import net.sourceforge.phpeclipse.resourcesview.PHPElementAdapterFactory;
  22 import net.sourceforge.phpeclipse.resourcesview.ResourceAdapterFactory;
  23 import org.eclipse.core.resources.IResource;
  24 import org.eclipse.core.resources.IWorkspace;
  25 import org.eclipse.core.resources.ResourcesPlugin;
  26 import org.eclipse.core.runtime.CoreException;
  27 import org.eclipse.core.runtime.IAdapterManager;
  28 import org.eclipse.core.runtime.IPath;
  29 import org.eclipse.core.runtime.IPluginDescriptor;
  30 import org.eclipse.core.runtime.IStatus;
  31 import org.eclipse.core.runtime.Path;
  32 import org.eclipse.core.runtime.Platform;
  33 import org.eclipse.core.runtime.Status;
  34 import org.eclipse.jface.preference.IPreferenceStore;
  35 import org.eclipse.jface.preference.PreferenceConverter;
  36 import org.eclipse.swt.widgets.Shell;
  37 import org.eclipse.ui.IWorkbenchPage;
  38 import org.eclipse.ui.IWorkbenchWindow;
  39 import org.eclipse.ui.plugin.AbstractUIPlugin;
  40
  41 /**
  42  * The main plugin class to be used in the desktop.
  43  */
  44 public class PHPeclipsePlugin extends AbstractUIPlugin implements IPreferenceConstants {
  45   //    public static final String LOCALHOST_PREF = "_localhost";
  46   //    public static final String DOCUMENTROOT_PREF = "_documentroot";
  47   //    public static final String USE_EXTERNAL_BROWSER_PREF = "_use_external_browser";
  48   //    public static final String EXTERNAL_BROWSER_PREF = "_external_browser";
  49   //    public static final String MYSQL_PREF = "_my_sql";
  50   //    public static final String APACHE_START_PREF = "_apache_start";
  51   //    public static final String APACHE_STOP_PREF = "_apache_stop";
  52   //    public static final String APACHE_RESTART_PREF = "_apache_restart";
  53   //  public static final String SHOW_OUTPUT_IN_CONSOLE = "_sho_output_in_console";
  54   //  public static final String EXTERNAL_PARSER_PREF = "_external_parser";
  55
  56   /**
  57    * The id of the PHP plugin (value <code>"net.sourceforge.phpeclipse"</code>).
  58    */
  59   public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$
  60   public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
  61   public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
  62
  63   //The shared instance.
  64   private static PHPeclipsePlugin plugin;
  65   //Resource bundle.
  66   private ResourceBundle resourceBundle;
  67
  68   private ImageDescriptorRegistry fImageDescriptorRegistry;
  69   private PHPDocumentProvider fCompilationUnitDocumentProvider;
  70   /**
  71   * The Java virtual machine that we are running on.
  72   */
  73   private static int jvm;
  74
  75   /** MRJ 2.0 */
  76   private static final int MRJ_2_0 = 0;
  77
  78   /** MRJ 2.1 or later */
  79   private static final int MRJ_2_1 = 1;
  80
  81   /** Java on Mac OS X 10.0 (MRJ 3.0) */
  82   private static final int MRJ_3_0 = 3;
  83
  84   /** MRJ 3.1 */
  85   private static final int MRJ_3_1 = 4;
  86
  87   /** Windows NT  */
  88   private static final int WINDOWS_NT = 5;
  89
  90   /** Windows 9x  */
  91   private static final int WINDOWS_9x = 6;
  92
  93   /** JVM constant for any other platform */
  94   private static final int OTHER = -1;
  95   /**
  96    * The constructor.
  97    */
  98   public PHPeclipsePlugin(IPluginDescriptor descriptor) {
  99     super(descriptor);
 100     plugin = this;
 101     setJVM();
 102     try {
 103       resourceBundle = ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
 104     } catch (MissingResourceException x) {
 105       resourceBundle = null;
 106     }
 107   }
 108
 109   public static ImageDescriptorRegistry getImageDescriptorRegistry() {
 110     return getDefault().internalGetImageDescriptorRegistry();
 111   }
 112
 113   private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
 114     if (fImageDescriptorRegistry == null)
 115       fImageDescriptorRegistry= new ImageDescriptorRegistry();
 116     return fImageDescriptorRegistry;
 117   }
 118   // @TODO: refactor this into a better method name !
 119   public PHPDocumentProvider getCompilationUnitDocumentProvider() {
 120     if (fCompilationUnitDocumentProvider == null)
 121       fCompilationUnitDocumentProvider = new PHPDocumentProvider();
 122     return fCompilationUnitDocumentProvider;
 123   }
 124
 125   public static void setJVM() {
 126     String osName = System.getProperty("os.name");
 127
 128     if (osName.startsWith("Mac OS")) {
 129       String mrjVersion = System.getProperty("mrj.version");
 130       String majorMRJVersion = mrjVersion.substring(0, 3);
 131       jvm = OTHER;
 132       try {
 133
 134         double version = Double.valueOf(majorMRJVersion).doubleValue();
 135
 136         if (version == 2) {
 137           jvm = MRJ_2_0;
 138         } else if (version >= 2.1 && version < 3) {
 139           jvm = MRJ_2_1;
 140         } else if (version == 3.0) {
 141           jvm = MRJ_3_0;
 142         } else if (version >= 3.1) {
 143           jvm = MRJ_3_1;
 144         }
 145
 146       } catch (NumberFormatException nfe) {
 147
 148       }
 149
 150     } else if (osName.startsWith("Windows")) {
 151       if (osName.indexOf("9") != -1) {
 152         jvm = WINDOWS_9x;
 153       } else {
 154         jvm = WINDOWS_NT;
 155       }
 156     }
 157   }
 158   public static int getJVM() {
 159     return jvm;
 160   }
 161   /**
 162    * Returns the shared instance.
 163    */
 164   public static PHPeclipsePlugin getDefault() {
 165     return plugin;
 166   }
 167
 168   /**
 169    * Returns the workspace instance.
 170    */
 171   public static IWorkspace getWorkspace() {
 172     return ResourcesPlugin.getWorkspace();
 173   }
 174
 175   public static IWorkbenchPage getActivePage() {
 176     return getDefault().getActivePage();
 177   }
 178
 179   public static IWorkbenchWindow getActiveWorkbenchWindow() {
 180     return getDefault().getWorkbench().getActiveWorkbenchWindow();
 181   }
 182
 183   public static Shell getActiveWorkbenchShell() {
 184     return getActiveWorkbenchWindow().getShell();
 185   }
 186
 187   public static String getPluginId() {
 188     return getDefault().getDescriptor().getUniqueIdentifier();
 189   }
 190
 191   public static void log(IStatus status) {
 192     getDefault().getLog().log(status);
 193   }
 194
 195   //  public static void logErrorMessage(String message) {
 196   //    log(new Status(IStatus.ERROR, getPluginId(), JavaStatusConstants.INTERNAL_ERROR, message, null));
 197   //  }
 198   //
 199   //  public static void logErrorStatus(String message, IStatus status) {
 200   //    if (status == null) {
 201   //      logErrorMessage(message);
 202   //      return;
 203   //    }
 204   //    MultiStatus multi= new MultiStatus(getPluginId(), JavaStatusConstants.INTERNAL_ERROR, message, null);
 205   //    multi.add(status);
 206   //    log(multi);
 207   //  }
 208   //
 209   //  public static void log(Throwable e) {
 210   //    log(new Status(IStatus.ERROR, getPluginId(), JavaStatusConstants.INTERNAL_ERROR, JavaUIMessages.getString("JavaPlugin.internal_error"), e)); //$NON-NLS-1$
 211   //  }
 212   public static void log(int severity, String message) {
 213     Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null) ;
 214     log(status) ;
 215   }
 216   public static void log(Throwable e) {
 217     log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$
 218   }
 219   public static boolean isDebug() {
 220     return getDefault().isDebugging();
 221   }
 222
 223   static IPath getInstallLocation() {
 224     return new Path(getDefault().getDescriptor().getInstallURL().getFile());
 225   }
 226
 227   /**
 228    * Returns the string from the plugin's resource bundle,
 229    * or 'key' if not found.
 230    */
 231   public static String getResourceString(String key) {
 232     ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
 233     try {
 234       return bundle.getString(key);
 235     } catch (MissingResourceException e) {
 236       return key;
 237     }
 238   }
 239
 240   /**
 241    * Returns the plugin's resource bundle,
 242    */
 243   public ResourceBundle getResourceBundle() {
 244     return resourceBundle;
 245   }
 246
 247   protected void initializeDefaultPreferences(IPreferenceStore store) {
 248     // windows preferences:
 249     store.setDefault(LOCALHOST_PREF, "http://localhost");
 250
 251     store.setDefault(USE_EXTERNAL_BROWSER_PREF, "false");
 252     store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
 253     if (jvm == WINDOWS_9x) {
 254       store.setDefault(EXTERNAL_BROWSER_PREF, "command.com /c start iexplore {0}");
 255     } else if (jvm == WINDOWS_NT) {
 256       store.setDefault(EXTERNAL_BROWSER_PREF, "rundll32 url.dll,FileProtocolHandler {0}");
 257     } else {
 258       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
 259     }
 260     store.setDefault(DOCUMENTROOT_PREF, getWorkspace().getRoot().getLocation().toString() );
 261     // store.setDefault(DOCUMENTROOT_PREF, "c:\\eclipse\\workspace");  // WIN_32
 262     // store.setDefault(DOCUMENTROOT_PREF, "/eclipse/workspace");      // UNIX
 263     if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) {
 264       store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
 265       store.setDefault(MYSQL_PREF, "c:\\apache\\mysql\\bin\\mysqld.exe --standalone");
 266       store.setDefault(APACHE_START_PREF, "c:\\apache\\apache.exe -c \"DocumentRoot \"{0}\"\"");
 267       store.setDefault(APACHE_STOP_PREF, "c:\\apache\\apache.exe -k shutdown");
 268       store.setDefault(APACHE_RESTART_PREF, "c:\\apache\\apache.exe -k restart");
 269     } else {
 270       store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
 271       store.setDefault(MYSQL_PREF, "/apache/mysql/bin/mysqld --standalone");
 272       store.setDefault(APACHE_START_PREF, "/apache/apache -c \"DocumentRoot \"{0}\"\"");
 273       store.setDefault(APACHE_STOP_PREF, "/apache/apache.exe -k shutdown");
 274       store.setDefault(APACHE_RESTART_PREF, "/apache/apache -k restart");
 275
 276     }
 277
 278     store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
 279     store.setDefault(PHP_INTERNAL_PARSER, "false");
 280     store.setDefault(PHP_EXTERNAL_PARSER, "true");
 281
 282     store.setDefault(PHP_PARSE_ON_SAVE, "true");
 283
 284     // show line numbers:
 285     store.setDefault(LINE_NUMBER_RULER, "false");
 286
 287     // php syntax highlighting
 288     PreferenceConverter.setDefault(store, PHP_MULTILINE_COMMENT, PHPColorProvider.MULTI_LINE_COMMENT);
 289     PreferenceConverter.setDefault(store, PHP_SINGLELINE_COMMENT, PHPColorProvider.SINGLE_LINE_COMMENT);
 290     PreferenceConverter.setDefault(store, PHP_KEYWORD, PHPColorProvider.KEYWORD);
 291     PreferenceConverter.setDefault(store, PHP_VARIABLE, PHPColorProvider.VARIABLE);
 292     PreferenceConverter.setDefault(store, PHP_FUNCTIONNAME, PHPColorProvider.FUNCTION_NAME);
 293     PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING);
 294     PreferenceConverter.setDefault(store, PHP_DEFAULT, PHPColorProvider.DEFAULT);
 295     PreferenceConverter.setDefault(store, LINKED_POSITION_COLOR, PHPColorProvider.LINKED_POSITION_COLOR);
 296     PreferenceConverter.setDefault(store, LINE_NUMBER_COLOR, PHPColorProvider.LINE_NUMBER_COLOR);
 297
 298     store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
 299     PreferenceConverter.setDefault(store, PREFERENCE_COLOR_BACKGROUND, PHPColorProvider.BACKGROUND_COLOR);
 300   }
 301
 302     public void startup() throws CoreException {
 303     super.startup();
 304     IAdapterManager manager= Platform.getAdapterManager();
 305     manager.registerAdapters(new PHPElementAdapterFactory(), PHPElement.class);
 306     manager.registerAdapters(new ResourceAdapterFactory(), IResource.class);
 307   }
 308 }