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