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 net.sourceforge.phpdt.internal.ui.preferences.TemplatePreferencePage;
  15 import net.sourceforge.phpdt.internal.ui.viewsupport.ImageDescriptorRegistry;
  16 import net.sourceforge.phpeclipse.phpeditor.PHPDocumentProvider;
  17 import net.sourceforge.phpeclipse.phpeditor.PHPSyntaxRdr;
  18 import net.sourceforge.phpeclipse.phpeditor.util.PHPColorProvider;
  19 import net.sourceforge.phpeclipse.resourcesview.PHPElement;
  20 import net.sourceforge.phpeclipse.resourcesview.PHPElementAdapterFactory;
  21 import net.sourceforge.phpeclipse.resourcesview.ResourceAdapterFactory;
  22
  23 import org.eclipse.core.boot.BootLoader;
  24 import org.eclipse.core.resources.IResource;
  25 import org.eclipse.core.resources.IWorkspace;
  26 import org.eclipse.core.resources.ResourcesPlugin;
  27 import org.eclipse.core.runtime.CoreException;
  28 import org.eclipse.core.runtime.IAdapterManager;
  29 import org.eclipse.core.runtime.IPath;
  30 import org.eclipse.core.runtime.IPluginDescriptor;
  31 import org.eclipse.core.runtime.IStatus;
  32 import org.eclipse.core.runtime.Path;
  33 import org.eclipse.core.runtime.Platform;
  34 import org.eclipse.core.runtime.Status;
  35 import org.eclipse.jface.preference.IPreferenceStore;
  36 import org.eclipse.jface.preference.PreferenceConverter;
  37 import org.eclipse.swt.widgets.Shell;
  38 import org.eclipse.ui.IWorkbenchPage;
  39 import org.eclipse.ui.IWorkbenchWindow;
  40 import org.eclipse.ui.plugin.AbstractUIPlugin;
  41
  42 /**
  43  * The main plugin class to be used in the desktop.
  44  */
  45 public class PHPeclipsePlugin
  46   extends AbstractUIPlugin
  47   implements IPreferenceConstants {
  48   //    public static final String LOCALHOST_PREF = "_localhost";
  49   //    public static final String DOCUMENTROOT_PREF = "_documentroot";
  50   //    public static final String USE_EXTERNAL_BROWSER_PREF = "_use_external_browser";
  51   //    public static final String EXTERNAL_BROWSER_PREF = "_external_browser";
  52   //    public static final String MYSQL_PREF = "_my_sql";
  53   //    public static final String APACHE_START_PREF = "_apache_start";
  54   //    public static final String APACHE_STOP_PREF = "_apache_stop";
  55   //    public static final String APACHE_RESTART_PREF = "_apache_restart";
  56   //  public static final String SHOW_OUTPUT_IN_CONSOLE = "_sho_output_in_console";
  57   //  public static final String EXTERNAL_PARSER_PREF = "_external_parser";
  58
  59   /**
  60    * The id of the PHP plugin (value <code>"net.sourceforge.phpeclipse"</code>).
  61    */
  62   public static final String PLUGIN_ID = "net.sourceforge.phpeclipse"; //$NON-NLS-1$
  63   public final static String PHP_NATURE_ID = PLUGIN_ID + ".phpnature";
  64   // public static final String PHP_RESOURCES_VIEW_ID = PLUGIN_ID + ".resourcesview.ViewPHPResources"; //$NON-NLS-1$
  65   public static final String PHP_CODING_ACTION_SET_ID = PLUGIN_ID + ".ui.CodingActionSet"; //$NON-NLS-1$
  66
  67   public static final String PHPPARSER_NEW = "test.PHPParser";
  68   public static final String PHPPARSER_ORIGINAL =
  69     "net.sourceforge.phpdt.internal.compiler.parser.Parser";
  70
  71   /** Change this if you want to switch PHP Parser. */
  72   public static final String PHPPARSER = PHPPARSER_ORIGINAL;
  73
  74   //The shared instance.
  75   private static PHPeclipsePlugin plugin;
  76   //Resource bundle.
  77   //private ResourceBundle resourceBundle;
  78
  79   private ImageDescriptorRegistry fImageDescriptorRegistry;
  80   private PHPDocumentProvider fCompilationUnitDocumentProvider;
  81   /**
  82   * The Java virtual machine that we are running on.
  83   */
  84   private static int jvm;
  85
  86   /** MRJ 2.0 */
  87   private static final int MRJ_2_0 = 0;
  88
  89   /** MRJ 2.1 or later */
  90   private static final int MRJ_2_1 = 1;
  91
  92   /** Java on Mac OS X 10.0 (MRJ 3.0) */
  93   private static final int MRJ_3_0 = 3;
  94
  95   /** MRJ 3.1 */
  96   private static final int MRJ_3_1 = 4;
  97
  98   /** Windows NT  */
  99   private static final int WINDOWS_NT = 5;
 100
 101   /** Windows 9x  */
 102   private static final int WINDOWS_9x = 6;
 103
 104   /** JVM constant for any other platform */
 105   private static final int OTHER = -1;
 106
 107   /** General debug flag*/
 108   public static final boolean DEBUG = false;
 109   /**
 110    * The constructor.
 111    */
 112   public PHPeclipsePlugin(IPluginDescriptor descriptor) {
 113     super(descriptor);
 114     plugin = this;
 115     setJVM();
 116     //    try {
 117     //      resourceBundle = ResourceBundle.getBundle("net.sourceforge.PHPeclipsePluginResources");
 118     //    } catch (MissingResourceException x) {
 119     //      resourceBundle = null;
 120     //    }
 121   }
 122
 123   public static ImageDescriptorRegistry getImageDescriptorRegistry() {
 124     return getDefault().internalGetImageDescriptorRegistry();
 125   }
 126
 127   private ImageDescriptorRegistry internalGetImageDescriptorRegistry() {
 128     if (fImageDescriptorRegistry == null)
 129       fImageDescriptorRegistry = new ImageDescriptorRegistry();
 130     return fImageDescriptorRegistry;
 131   }
 132   // @TODO: refactor this into a better method name !
 133   public PHPDocumentProvider getCompilationUnitDocumentProvider() {
 134     if (fCompilationUnitDocumentProvider == null)
 135       fCompilationUnitDocumentProvider = new PHPDocumentProvider();
 136     return fCompilationUnitDocumentProvider;
 137   }
 138
 139   private static void setJVM() {
 140     String osName = System.getProperty("os.name");
 141
 142     if (osName.startsWith("Mac OS")) {
 143       String mrjVersion = System.getProperty("mrj.version");
 144       String majorMRJVersion = mrjVersion.substring(0, 3);
 145       jvm = OTHER;
 146       try {
 147
 148         double version = Double.valueOf(majorMRJVersion).doubleValue();
 149
 150         if (version == 2) {
 151           jvm = MRJ_2_0;
 152         } else if (version >= 2.1 && version < 3) {
 153           jvm = MRJ_2_1;
 154         } else if (version == 3.0) {
 155           jvm = MRJ_3_0;
 156         } else if (version >= 3.1) {
 157           jvm = MRJ_3_1;
 158         }
 159
 160       } catch (NumberFormatException nfe) {
 161
 162       }
 163
 164     } else if (osName.startsWith("Windows")) {
 165       if (osName.indexOf("9") != -1) {
 166         jvm = WINDOWS_9x;
 167       } else {
 168         jvm = WINDOWS_NT;
 169       }
 170     }
 171   }
 172   public static int getJVM() {
 173     return jvm;
 174   }
 175   /**
 176    * Returns the shared instance.
 177    */
 178   public static PHPeclipsePlugin getDefault() {
 179     return plugin;
 180   }
 181
 182   /**
 183    * Returns the workspace instance.
 184    */
 185   public static IWorkspace getWorkspace() {
 186     return ResourcesPlugin.getWorkspace();
 187   }
 188
 189   public static IWorkbenchPage getActivePage() {
 190     return PHPeclipsePlugin.getActivePage();
 191   }
 192
 193   public static IWorkbenchWindow getActiveWorkbenchWindow() {
 194     return getDefault().getWorkbench().getActiveWorkbenchWindow();
 195   }
 196
 197   public static Shell getActiveWorkbenchShell() {
 198     return getActiveWorkbenchWindow().getShell();
 199   }
 200
 201   public static String getPluginId() {
 202     return getDefault().getDescriptor().getUniqueIdentifier();
 203   }
 204
 205   public static void log(IStatus status) {
 206     getDefault().getLog().log(status);
 207   }
 208
 209   //  public static void logErrorMessage(String message) {
 210   //    log(new Status(IStatus.ERROR, getPluginId(), JavaStatusConstants.INTERNAL_ERROR, message, null));
 211   //  }
 212   //
 213   //  public static void logErrorStatus(String message, IStatus status) {
 214   //    if (status == null) {
 215   //      logErrorMessage(message);
 216   //      return;
 217   //    }
 218   //    MultiStatus multi= new MultiStatus(getPluginId(), JavaStatusConstants.INTERNAL_ERROR, message, null);
 219   //    multi.add(status);
 220   //    log(multi);
 221   //  }
 222   //
 223   //  public static void log(Throwable e) {
 224   //    log(new Status(IStatus.ERROR, getPluginId(), JavaStatusConstants.INTERNAL_ERROR, JavaUIMessages.getString("JavaPlugin.internal_error"), e)); //$NON-NLS-1$
 225   //  }
 226
 227   public static void log(int severity, String message) {
 228     Status status = new Status(severity, PLUGIN_ID, IStatus.OK, message, null);
 229     log(status);
 230   }
 231   public static void log(Throwable e) {
 232     log(new Status(IStatus.ERROR, PLUGIN_ID, IStatus.ERROR, "PHPeclipsePlugin.internalErrorOccurred", e)); //$NON-NLS-1$
 233   }
 234
 235   public static boolean isDebug() {
 236     return getDefault().isDebugging();
 237   }
 238
 239   static IPath getInstallLocation() {
 240     return new Path(getDefault().getDescriptor().getInstallURL().getFile());
 241   }
 242
 243   /**
 244    * Returns the string from the plugin's resource bundle,
 245    * or 'key' if not found.
 246    */
 247   //  public static String getResourceString(String key) {
 248   //    ResourceBundle bundle = PHPeclipsePlugin.getDefault().getResourceBundle();
 249   //    try {
 250   //      return bundle.getString(key);
 251   //    } catch (MissingResourceException e) {
 252   //      return key;
 253   //    }
 254   //  }
 255
 256   /**
 257    * Returns the plugin's resource bundle,
 258    */
 259   //  public ResourceBundle getResourceBundle() {
 260   //    return resourceBundle;
 261   //  }
 262
 263   protected void initializeDefaultPreferences(IPreferenceStore store) {
 264     // windows preferences:
 265     store.setDefault(LOCALHOST_PREF, "http://localhost");
 266
 267     store.setDefault(USE_EXTERNAL_BROWSER_PREF, "false");
 268     store.setDefault(SHOW_OUTPUT_IN_CONSOLE, "true");
 269
 270     String windowsSystem = BootLoader.getWS();
 271
 272     if (jvm == WINDOWS_9x) {
 273       store.setDefault(
 274         EXTERNAL_BROWSER_PREF,
 275         "command.com /c start iexplore {0}");
 276     } else if (windowsSystem.equals(BootLoader.WS_WIN32)) {
 277       store.setDefault(
 278         EXTERNAL_BROWSER_PREF,
 279         "rundll32 url.dll,FileProtocolHandler {0}");
 280     } else {
 281       store.setDefault(EXTERNAL_BROWSER_PREF, "netscape {0}");
 282     }
 283     store.setDefault(
 284       DOCUMENTROOT_PREF,
 285       getWorkspace().getRoot().getLocation().toString());
 286     //  if ((jvm == WINDOWS_9x) || (jvm == WINDOWS_NT)) {
 287     if (windowsSystem.equals(BootLoader.WS_WIN32)) {
 288       store.setDefault(EXTERNAL_PARSER_PREF, "c:\\apache\\php\\php -l -f {0}");
 289       store.setDefault(
 290         MYSQL_PREF,
 291         "c:\\apache\\mysql\\bin\\mysqld.exe --standalone");
 292       store.setDefault(
 293         APACHE_START_PREF,
 294         "c:\\apache\\apache.exe -c \"DocumentRoot \"{0}\"\"");
 295       store.setDefault(APACHE_STOP_PREF, "c:\\apache\\apache.exe -k shutdown");
 296       store.setDefault(
 297         APACHE_RESTART_PREF,
 298         "c:\\apache\\apache.exe -k restart");
 299     } else {
 300       store.setDefault(EXTERNAL_PARSER_PREF, "/apache/php/php -l -f {0}");
 301       store.setDefault(MYSQL_PREF, "/apache/mysql/bin/mysqld --standalone");
 302       store.setDefault(
 303         APACHE_START_PREF,
 304         "/apache/apache -c \"DocumentRoot \"{0}\"\"");
 305       store.setDefault(APACHE_STOP_PREF, "/apache/apache.exe -k shutdown");
 306       store.setDefault(APACHE_RESTART_PREF, "/apache/apache -k restart");
 307
 308     }
 309
 310     store.setDefault(PHP_PARSER_DEFAULT, PHP_EXTERNAL_PARSER);
 311     store.setDefault(PHP_INTERNAL_PARSER, "false");
 312     store.setDefault(PHP_EXTERNAL_PARSER, "true");
 313
 314     store.setDefault(PHP_PARSE_ON_SAVE, "true");
 315
 316     // show line numbers:
 317     store.setDefault(LINE_NUMBER_RULER, "false");
 318     store.setDefault(FORMATTER_TAB_SIZE, "4");
 319
 320     // php syntax highlighting
 321     store.setDefault(PHP_USERDEF_XMLFILE, ""); //assume there is none  chooA
 322
 323     PreferenceConverter.setDefault(
 324       store,
 325       PHP_MULTILINE_COMMENT,
 326       PHPColorProvider.MULTI_LINE_COMMENT);
 327     PreferenceConverter.setDefault(
 328       store,
 329       PHP_SINGLELINE_COMMENT,
 330       PHPColorProvider.SINGLE_LINE_COMMENT);
 331     PreferenceConverter.setDefault(
 332       store,
 333       PHP_KEYWORD,
 334       PHPColorProvider.KEYWORD);
 335     PreferenceConverter.setDefault(
 336       store,
 337       PHP_VARIABLE,
 338       PHPColorProvider.VARIABLE);
 339     PreferenceConverter.setDefault(
 340       store,
 341       PHP_FUNCTIONNAME,
 342       PHPColorProvider.FUNCTION_NAME);
 343     PreferenceConverter.setDefault(
 344       store,
 345       PHP_CONSTANT,
 346       PHPColorProvider.CONSTANT);
 347     PreferenceConverter.setDefault(store, PHP_TYPE, PHPColorProvider.TYPE);
 348     PreferenceConverter.setDefault(store, PHP_STRING, PHPColorProvider.STRING);
 349     PreferenceConverter.setDefault(
 350       store,
 351       PHP_DEFAULT,
 352       PHPColorProvider.DEFAULT);
 353     PreferenceConverter.setDefault(
 354       store,
 355       PHP_EDITOR_BACKGROUND,
 356       PHPColorProvider.BACKGROUND);
 357     PreferenceConverter.setDefault(
 358       store,
 359       LINKED_POSITION_COLOR,
 360       PHPColorProvider.LINKED_POSITION_COLOR);
 361     PreferenceConverter.setDefault(
 362       store,
 363       LINE_NUMBER_COLOR,
 364       PHPColorProvider.LINE_NUMBER_COLOR);
 365
 366     // set default PHPDoc colors:
 367     PreferenceConverter.setDefault(
 368       store,
 369       PHPDOC_KEYWORD,
 370       PHPColorProvider.PHPDOC_KEYWORD);
 371     PreferenceConverter.setDefault(
 372       store,
 373       PHPDOC_LINK,
 374       PHPColorProvider.PHPDOC_LINK);
 375     PreferenceConverter.setDefault(
 376       store,
 377       PHPDOC_DEFAULT,
 378       PHPColorProvider.PHPDOC_DEFAULT);
 379     PreferenceConverter.setDefault(
 380       store,
 381       PHPDOC_TAG,
 382       PHPColorProvider.PHPDOC_TAG);
 383
 384     store.setDefault(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT, "true");
 385     PreferenceConverter.setDefault(
 386       store,
 387       PREFERENCE_COLOR_BACKGROUND,
 388       PHPColorProvider.BACKGROUND_COLOR);
 389
 390     //language stuff
 391     store.setDefault(RESOURCE_BUNDLE, LANGUAGE_DEFAULT);
 392     store.setDefault(RESOURCE_BUNDLE_EN_GB, "true");
 393     store.setDefault(RESOURCE_BUNDLE_DE, "false");
 394     store.setDefault(RESOURCE_BUNDLE_FR, "false");
 395     store.setDefault(RESOURCE_BUNDLE_ES, "false");
 396
 397     store.setDefault(PHP_OUTLINE_CLASS, "true"); //$NON-NLS-1$
 398     store.setDefault(PHP_OUTLINE_FUNC, "true"); //$NON-NLS-1$
 399     store.setDefault(PHP_OUTLINE_VAR, "true"); //$NON-NLS-1$
 400
 401     TemplatePreferencePage.initDefaults(store);
 402     //this will initialize the static fields in the syntaxrdr class
 403     new PHPSyntaxRdr();
 404
 405     PHPCore.initializeDefaultPluginPreferences();
 406   }
 407
 408   public void startup() throws CoreException {
 409     super.startup();
 410     IAdapterManager manager = Platform.getAdapterManager();
 411     manager.registerAdapters(new PHPElementAdapterFactory(), PHPElement.class);
 412     manager.registerAdapters(new ResourceAdapterFactory(), IResource.class);
 413   }
 414 }