net.sourceforge.phpeclipse/src/net/sourceforge/phpeclipse/phpeditor/PHPEditor.java

   1 package net.sourceforge.phpeclipse.phpeditor;
   2
   3 /**********************************************************************
   4  Copyright (c) 2000, 2002 IBM Corp. and others.
   5  All rights reserved. This program and the accompanying materials
   6  are made available under the terms of the Common Public License v1.0
   7  which accompanies this distribution, and is available at
   8  http://www.eclipse.org/legal/cpl-v10.html
   9
  10  Contributors:
  11  IBM Corporation - Initial implementation
  12  www.phpeclipse.de
  13  **********************************************************************/
  14 import java.lang.reflect.InvocationTargetException;
  15 import java.lang.reflect.Method;
  16 import java.text.BreakIterator;
  17 import java.text.CharacterIterator;
  18 import java.util.ArrayList;
  19 import java.util.HashMap;
  20 import java.util.Iterator;
  21 import java.util.List;
  22 import java.util.Map;
  23 import java.util.ResourceBundle;
  24 import java.util.StringTokenizer;
  25
  26 import net.sourceforge.phpdt.core.ICompilationUnit;
  27 import net.sourceforge.phpdt.core.IImportContainer;
  28 import net.sourceforge.phpdt.core.IImportDeclaration;
  29 import net.sourceforge.phpdt.core.IJavaElement;
  30 import net.sourceforge.phpdt.core.IJavaProject;
  31 import net.sourceforge.phpdt.core.IMember;
  32 import net.sourceforge.phpdt.core.ISourceRange;
  33 import net.sourceforge.phpdt.core.ISourceReference;
  34 import net.sourceforge.phpdt.core.JavaCore;
  35 import net.sourceforge.phpdt.core.JavaModelException;
  36 import net.sourceforge.phpdt.core.compiler.ITerminalSymbols;
  37 import net.sourceforge.phpdt.core.compiler.InvalidInputException;
  38 import net.sourceforge.phpdt.internal.compiler.parser.Scanner;
  39 import net.sourceforge.phpdt.internal.compiler.parser.SyntaxError;
  40 import net.sourceforge.phpdt.internal.core.CompilationUnit;
  41 import net.sourceforge.phpdt.internal.ui.actions.CompositeActionGroup;
  42 import net.sourceforge.phpdt.internal.ui.actions.FoldingActionGroup;
  43 import net.sourceforge.phpdt.internal.ui.actions.SelectionConverter;
  44 import net.sourceforge.phpdt.internal.ui.text.CustomSourceInformationControl;
  45 import net.sourceforge.phpdt.internal.ui.text.DocumentCharacterIterator;
  46 import net.sourceforge.phpdt.internal.ui.text.HTMLTextPresenter;
  47 import net.sourceforge.phpdt.internal.ui.text.IPHPPartitions;
  48 import net.sourceforge.phpdt.internal.ui.text.JavaWordFinder;
  49 import net.sourceforge.phpdt.internal.ui.text.JavaWordIterator;
  50 import net.sourceforge.phpdt.internal.ui.text.PHPPairMatcher;
  51 import net.sourceforge.phpdt.internal.ui.text.PreferencesAdapter;
  52 import net.sourceforge.phpdt.internal.ui.text.java.JavaExpandHover;
  53 import net.sourceforge.phpdt.internal.ui.viewsupport.ISelectionListenerWithAST;
  54 import net.sourceforge.phpdt.internal.ui.viewsupport.IViewPartInputProvider;
  55 import net.sourceforge.phpdt.internal.ui.viewsupport.SelectionListenerWithASTManager;
  56 import net.sourceforge.phpdt.ui.IContextMenuConstants;
  57 import net.sourceforge.phpdt.ui.JavaUI;
  58 import net.sourceforge.phpdt.ui.PreferenceConstants;
  59 import net.sourceforge.phpdt.ui.actions.GotoMatchingBracketAction;
  60 import net.sourceforge.phpdt.ui.actions.OpenEditorActionGroup;
  61 import net.sourceforge.phpdt.ui.text.JavaTextTools;
  62 import net.sourceforge.phpdt.ui.text.PHPSourceViewerConfiguration;
  63 import net.sourceforge.phpdt.ui.text.folding.IJavaFoldingStructureProvider;
  64 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
  65 import net.sourceforge.phpeclipse.ui.editor.BrowserUtil;
  66 import net.sourceforge.phpeclipse.webbrowser.views.BrowserView;
  67
  68 import org.eclipse.core.resources.IMarker;
  69 import org.eclipse.core.resources.IResource;
  70 import org.eclipse.core.runtime.CoreException;
  71 import org.eclipse.core.runtime.IProgressMonitor;
  72 import org.eclipse.core.runtime.IStatus;
  73 import org.eclipse.core.runtime.NullProgressMonitor;
  74 import org.eclipse.core.runtime.Preferences;
  75 import org.eclipse.core.runtime.Status;
  76 import org.eclipse.core.runtime.jobs.Job;
  77 import org.eclipse.jface.action.Action;
  78 import org.eclipse.jface.action.GroupMarker;
  79 import org.eclipse.jface.action.IAction;
  80 import org.eclipse.jface.action.MenuManager;
  81 import org.eclipse.jface.action.Separator;
  82 import org.eclipse.jface.preference.IPreferenceStore;
  83 import org.eclipse.jface.preference.PreferenceConverter;
  84 import org.eclipse.jface.text.BadLocationException;
  85 import org.eclipse.jface.text.DefaultInformationControl;
  86 import org.eclipse.jface.text.DocumentEvent;
  87 import org.eclipse.jface.text.IDocument;
  88 import org.eclipse.jface.text.IDocumentExtension4;
  89 import org.eclipse.jface.text.IDocumentListener;
  90 import org.eclipse.jface.text.IInformationControl;
  91 import org.eclipse.jface.text.IInformationControlCreator;
  92 import org.eclipse.jface.text.IRegion;
  93 import org.eclipse.jface.text.ISelectionValidator;
  94 import org.eclipse.jface.text.ISynchronizable;
  95 import org.eclipse.jface.text.ITextHover;
  96 import org.eclipse.jface.text.ITextInputListener;
  97 import org.eclipse.jface.text.ITextPresentationListener;
  98 import org.eclipse.jface.text.ITextSelection;
  99 import org.eclipse.jface.text.ITextViewer;
 100 import org.eclipse.jface.text.ITextViewerExtension2;
 101 import org.eclipse.jface.text.ITextViewerExtension3;
 102 import org.eclipse.jface.text.ITextViewerExtension4;
 103 import org.eclipse.jface.text.ITextViewerExtension5;
 104 import org.eclipse.jface.text.ITypedRegion;
 105 import org.eclipse.jface.text.Position;
 106 import org.eclipse.jface.text.Region;
 107 import org.eclipse.jface.text.TextPresentation;
 108 import org.eclipse.jface.text.TextSelection;
 109 import org.eclipse.jface.text.TextUtilities;
 110 import org.eclipse.jface.text.information.IInformationProvider;
 111 import org.eclipse.jface.text.information.InformationPresenter;
 112 import org.eclipse.jface.text.link.LinkedModeModel;
 113 import org.eclipse.jface.text.reconciler.IReconciler;
 114 import org.eclipse.jface.text.source.Annotation;
 115 import org.eclipse.jface.text.source.AnnotationRulerColumn;
 116 import org.eclipse.jface.text.source.CompositeRuler;
 117 import org.eclipse.jface.text.source.IAnnotationModel;
 118 import org.eclipse.jface.text.source.IAnnotationModelExtension;
 119 import org.eclipse.jface.text.source.IOverviewRuler;
 120 import org.eclipse.jface.text.source.ISourceViewer;
 121 import org.eclipse.jface.text.source.ISourceViewerExtension2;
 122 import org.eclipse.jface.text.source.IVerticalRuler;
 123 import org.eclipse.jface.text.source.OverviewRuler;
 124 import org.eclipse.jface.text.source.SourceViewerConfiguration;
 125 import org.eclipse.jface.text.source.projection.ProjectionSupport;
 126 import org.eclipse.jface.text.source.projection.ProjectionViewer;
 127 import org.eclipse.jface.util.IPropertyChangeListener;
 128 import org.eclipse.jface.util.ListenerList;
 129 import org.eclipse.jface.util.PropertyChangeEvent;
 130 import org.eclipse.jface.viewers.DoubleClickEvent;
 131 import org.eclipse.jface.viewers.IDoubleClickListener;
 132 import org.eclipse.jface.viewers.IPostSelectionProvider;
 133 import org.eclipse.jface.viewers.ISelection;
 134 import org.eclipse.jface.viewers.ISelectionChangedListener;
 135 import org.eclipse.jface.viewers.ISelectionProvider;
 136 import org.eclipse.jface.viewers.IStructuredSelection;
 137 import org.eclipse.jface.viewers.SelectionChangedEvent;
 138 import org.eclipse.jface.viewers.StructuredSelection;
 139 import org.eclipse.swt.SWT;
 140 import org.eclipse.swt.custom.BidiSegmentEvent;
 141 import org.eclipse.swt.custom.BidiSegmentListener;
 142 import org.eclipse.swt.custom.ST;
 143 import org.eclipse.swt.custom.StyleRange;
 144 import org.eclipse.swt.custom.StyledText;
 145 import org.eclipse.swt.events.FocusEvent;
 146 import org.eclipse.swt.events.FocusListener;
 147 import org.eclipse.swt.events.KeyEvent;
 148 import org.eclipse.swt.events.KeyListener;
 149 import org.eclipse.swt.events.MouseEvent;
 150 import org.eclipse.swt.events.MouseListener;
 151 import org.eclipse.swt.events.MouseMoveListener;
 152 import org.eclipse.swt.events.PaintEvent;
 153 import org.eclipse.swt.events.PaintListener;
 154 import org.eclipse.swt.graphics.Color;
 155 import org.eclipse.swt.graphics.Cursor;
 156 import org.eclipse.swt.graphics.GC;
 157 import org.eclipse.swt.graphics.Image;
 158 import org.eclipse.swt.graphics.Point;
 159 import org.eclipse.swt.graphics.RGB;
 160 import org.eclipse.swt.widgets.Composite;
 161 import org.eclipse.swt.widgets.Control;
 162 import org.eclipse.swt.widgets.Display;
 163 import org.eclipse.swt.widgets.Shell;
 164 import org.eclipse.ui.IEditorInput;
 165 import org.eclipse.ui.IEditorPart;
 166 import org.eclipse.ui.IPageLayout;
 167 import org.eclipse.ui.IPartService;
 168 import org.eclipse.ui.ISelectionListener;
 169 import org.eclipse.ui.IViewPart;
 170 import org.eclipse.ui.IWindowListener;
 171 import org.eclipse.ui.IWorkbenchPage;
 172 import org.eclipse.ui.IWorkbenchPart;
 173 import org.eclipse.ui.IWorkbenchWindow;
 174 import org.eclipse.ui.PlatformUI;
 175 import org.eclipse.ui.actions.ActionContext;
 176 import org.eclipse.ui.actions.ActionGroup;
 177 import org.eclipse.ui.editors.text.DefaultEncodingSupport;
 178 import org.eclipse.ui.editors.text.EditorsUI;
 179 import org.eclipse.ui.editors.text.IEncodingSupport;
 180 import org.eclipse.ui.part.FileEditorInput;
 181 import org.eclipse.ui.part.IShowInSource;
 182 import org.eclipse.ui.part.IShowInTargetList;
 183 import org.eclipse.ui.part.ShowInContext;
 184 import org.eclipse.ui.texteditor.AbstractDecoratedTextEditor;
 185 import org.eclipse.ui.texteditor.AnnotationPreference;
 186 import org.eclipse.ui.texteditor.ChainedPreferenceStore;
 187 import org.eclipse.ui.texteditor.IDocumentProvider;
 188 import org.eclipse.ui.texteditor.IEditorStatusLine;
 189 import org.eclipse.ui.texteditor.ITextEditorActionConstants;
 190 import org.eclipse.ui.texteditor.ITextEditorActionDefinitionIds;
 191 import org.eclipse.ui.texteditor.IUpdate;
 192 import org.eclipse.ui.texteditor.MarkerAnnotation;
 193 import org.eclipse.ui.texteditor.SourceViewerDecorationSupport;
 194 import org.eclipse.ui.texteditor.TextEditorAction;
 195 import org.eclipse.ui.texteditor.TextNavigationAction;
 196 import org.eclipse.ui.texteditor.TextOperationAction;
 197 import org.eclipse.ui.views.contentoutline.ContentOutline;
 198 import org.eclipse.ui.views.contentoutline.IContentOutlinePage;
 199 import org.eclipse.ui.views.tasklist.TaskList;
 200
 201 /**
 202  * PHP specific text editor.
 203  */
 204 public abstract class PHPEditor extends AbstractDecoratedTextEditor implements IViewPartInputProvider, IShowInTargetList,
 205                 IShowInSource {
 206         // extends StatusTextEditor implements IViewPartInputProvider { // extends
 207         // TextEditor {
 208
 209         /**
 210          * Internal implementation class for a change listener.
 211          *
 212          * @since 3.0
 213          */
 214         protected abstract class AbstractSelectionChangedListener implements ISelectionChangedListener {
 215
 216                 /**
 217                  * Installs this selection changed listener with the given selection
 218                  * provider. If the selection provider is a post selection provider, post
 219                  * selection changed events are the preferred choice, otherwise normal
 220                  * selection changed events are requested.
 221                  *
 222                  * @param selectionProvider
 223                  */
 224                 public void install(ISelectionProvider selectionProvider) {
 225                         if (selectionProvider == null)
 226                                 return;
 227
 228                         if (selectionProvider instanceof IPostSelectionProvider) {
 229                                 IPostSelectionProvider provider = (IPostSelectionProvider) selectionProvider;
 230                                 provider.addPostSelectionChangedListener(this);
 231                         } else {
 232                                 selectionProvider.addSelectionChangedListener(this);
 233                         }
 234                 }
 235
 236                 /**
 237                  * Removes this selection changed listener from the given selection
 238                  * provider.
 239                  *
 240                  * @param selectionProvider
 241                  *          the selection provider
 242                  */
 243                 public void uninstall(ISelectionProvider selectionProvider) {
 244                         if (selectionProvider == null)
 245                                 return;
 246
 247                         if (selectionProvider instanceof IPostSelectionProvider) {
 248                                 IPostSelectionProvider provider = (IPostSelectionProvider) selectionProvider;
 249                                 provider.removePostSelectionChangedListener(this);
 250                         } else {
 251                                 selectionProvider.removeSelectionChangedListener(this);
 252                         }
 253                 }
 254         }
 255
 256         /**
 257          * Updates the Java outline page selection and this editor's range indicator.
 258          *
 259          * @since 3.0
 260          */
 261         private class EditorSelectionChangedListener extends AbstractSelectionChangedListener {
 262
 263                 /*
 264                  * @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)
 265                  */
 266                 public void selectionChanged(SelectionChangedEvent event) {
 267                         // XXX: see https://bugs.eclipse.org/bugs/show_bug.cgi?id=56161
 268                         PHPEditor.this.selectionChanged();
 269                 }
 270         }
 271
 272         /**
 273          * "Smart" runnable for updating the outline page's selection.
 274          */
 275         // class OutlinePageSelectionUpdater implements Runnable {
 276         //
 277         // /** Has the runnable already been posted? */
 278         // private boolean fPosted = false;
 279         //
 280         // public OutlinePageSelectionUpdater() {
 281         // }
 282         //
 283         // /*
 284         // * @see Runnable#run()
 285         // */
 286         // public void run() {
 287         // synchronizeOutlinePageSelection();
 288         // fPosted = false;
 289         // }
 290         //
 291         // /**
 292         // * Posts this runnable into the event queue.
 293         // */
 294         // public void post() {
 295         // if (fPosted)
 296         // return;
 297         //
 298         // Shell shell = getSite().getShell();
 299         // if (shell != null & !shell.isDisposed()) {
 300         // fPosted = true;
 301         // shell.getDisplay().asyncExec(this);
 302         // }
 303         // }
 304         // };
 305         class SelectionChangedListener implements ISelectionChangedListener {
 306                 public void selectionChanged(SelectionChangedEvent event) {
 307                         doSelectionChanged(event);
 308                 }
 309         };
 310
 311         /**
 312          * Adapts an options {@link java.util.Map}to
 313          * {@link org.eclipse.jface.preference.IPreferenceStore}.
 314          * <p>
 315          * This preference store is read-only i.e. write access throws an
 316          * {@link java.lang.UnsupportedOperationException}.
 317          * </p>
 318          *
 319          * @since 3.0
 320          */
 321         private static class OptionsAdapter implements IPreferenceStore {
 322
 323                 /**
 324                  * A property change event filter.
 325                  */
 326                 public interface IPropertyChangeEventFilter {
 327
 328                         /**
 329                          * Should the given event be filtered?
 330                          *
 331                          * @param event
 332                          *          The property change event.
 333                          * @return <code>true</code> iff the given event should be filtered.
 334                          */
 335                         public boolean isFiltered(PropertyChangeEvent event);
 336
 337                 }
 338
 339                 /**
 340                  * Property change listener. Listens for events in the options Map and fires
 341                  * a {@link org.eclipse.jface.util.PropertyChangeEvent}on this adapter with
 342                  * arguments from the received event.
 343                  */
 344                 private class PropertyChangeListener implements IPropertyChangeListener {
 345
 346                         /**
 347                          * {@inheritDoc}
 348                          */
 349                         public void propertyChange(PropertyChangeEvent event) {
 350                                 if (getFilter().isFiltered(event))
 351                                         return;
 352
 353                                 if (event.getNewValue() == null)
 354                                         fOptions.remove(event.getProperty());
 355                                 else
 356                                         fOptions.put(event.getProperty(), event.getNewValue());
 357
 358                                 firePropertyChangeEvent(event.getProperty(), event.getOldValue(), event.getNewValue());
 359                         }
 360                 }
 361
 362                 /** Listeners on this adapter */
 363                 private ListenerList fListeners = new ListenerList();
 364
 365                 /** Listener on the adapted options Map */
 366                 private IPropertyChangeListener fListener = new PropertyChangeListener();
 367
 368                 /** Adapted options Map */
 369                 private Map fOptions;
 370
 371                 /** Preference store through which events are received. */
 372                 private IPreferenceStore fMockupPreferenceStore;
 373
 374                 /** Property event filter. */
 375                 private IPropertyChangeEventFilter fFilter;
 376
 377                 /**
 378                  * Initialize with the given options.
 379                  *
 380                  * @param options
 381                  *          The options to wrap
 382                  * @param mockupPreferenceStore
 383                  *          the mock-up preference store
 384                  * @param filter
 385                  *          the property change filter
 386                  */
 387                 public OptionsAdapter(Map options, IPreferenceStore mockupPreferenceStore, IPropertyChangeEventFilter filter) {
 388                         fMockupPreferenceStore = mockupPreferenceStore;
 389                         fOptions = options;
 390                         setFilter(filter);
 391                 }
 392
 393                 /**
 394                  * {@inheritDoc}
 395                  */
 396                 public void addPropertyChangeListener(IPropertyChangeListener listener) {
 397                         if (fListeners.size() == 0)
 398                                 fMockupPreferenceStore.addPropertyChangeListener(fListener);
 399                         fListeners.add(listener);
 400                 }
 401
 402                 /**
 403                  * {@inheritDoc}
 404                  */
 405                 public void removePropertyChangeListener(IPropertyChangeListener listener) {
 406                         fListeners.remove(listener);
 407                         if (fListeners.size() == 0)
 408                                 fMockupPreferenceStore.removePropertyChangeListener(fListener);
 409                 }
 410
 411                 /**
 412                  * {@inheritDoc}
 413                  */
 414                 public boolean contains(String name) {
 415                         return fOptions.containsKey(name);
 416                 }
 417
 418                 /**
 419                  * {@inheritDoc}
 420                  */
 421                 public void firePropertyChangeEvent(String name, Object oldValue, Object newValue) {
 422                         PropertyChangeEvent event = new PropertyChangeEvent(this, name, oldValue, newValue);
 423                         Object[] listeners = fListeners.getListeners();
 424                         for (int i = 0; i < listeners.length; i++)
 425                                 ((IPropertyChangeListener) listeners[i]).propertyChange(event);
 426                 }
 427
 428                 /**
 429                  * {@inheritDoc}
 430                  */
 431                 public boolean getBoolean(String name) {
 432                         boolean value = BOOLEAN_DEFAULT_DEFAULT;
 433                         String s = (String) fOptions.get(name);
 434                         if (s != null)
 435                                 value = s.equals(TRUE);
 436                         return value;
 437                 }
 438
 439                 /**
 440                  * {@inheritDoc}
 441                  */
 442                 public boolean getDefaultBoolean(String name) {
 443                         return BOOLEAN_DEFAULT_DEFAULT;
 444                 }
 445
 446                 /**
 447                  * {@inheritDoc}
 448                  */
 449                 public double getDefaultDouble(String name) {
 450                         return DOUBLE_DEFAULT_DEFAULT;
 451                 }
 452
 453                 /**
 454                  * {@inheritDoc}
 455                  */
 456                 public float getDefaultFloat(String name) {
 457                         return FLOAT_DEFAULT_DEFAULT;
 458                 }
 459
 460                 /**
 461                  * {@inheritDoc}
 462                  */
 463                 public int getDefaultInt(String name) {
 464                         return INT_DEFAULT_DEFAULT;
 465                 }
 466
 467                 /**
 468                  * {@inheritDoc}
 469                  */
 470                 public long getDefaultLong(String name) {
 471                         return LONG_DEFAULT_DEFAULT;
 472                 }
 473
 474                 /**
 475                  * {@inheritDoc}
 476                  */
 477                 public String getDefaultString(String name) {
 478                         return STRING_DEFAULT_DEFAULT;
 479                 }
 480
 481                 /**
 482                  * {@inheritDoc}
 483                  */
 484                 public double getDouble(String name) {
 485                         double value = DOUBLE_DEFAULT_DEFAULT;
 486                         String s = (String) fOptions.get(name);
 487                         if (s != null) {
 488                                 try {
 489                                         value = new Double(s).doubleValue();
 490                                 } catch (NumberFormatException e) {
 491                                 }
 492                         }
 493                         return value;
 494                 }
 495
 496                 /**
 497                  * {@inheritDoc}
 498                  */
 499                 public float getFloat(String name) {
 500                         float value = FLOAT_DEFAULT_DEFAULT;
 501                         String s = (String) fOptions.get(name);
 502                         if (s != null) {
 503                                 try {
 504                                         value = new Float(s).floatValue();
 505                                 } catch (NumberFormatException e) {
 506                                 }
 507                         }
 508                         return value;
 509                 }
 510
 511                 /**
 512                  * {@inheritDoc}
 513                  */
 514                 public int getInt(String name) {
 515                         int value = INT_DEFAULT_DEFAULT;
 516                         String s = (String) fOptions.get(name);
 517                         if (s != null) {
 518                                 try {
 519                                         value = new Integer(s).intValue();
 520                                 } catch (NumberFormatException e) {
 521                                 }
 522                         }
 523                         return value;
 524                 }
 525
 526                 /**
 527                  * {@inheritDoc}
 528                  */
 529                 public long getLong(String name) {
 530                         long value = LONG_DEFAULT_DEFAULT;
 531                         String s = (String) fOptions.get(name);
 532                         if (s != null) {
 533                                 try {
 534                                         value = new Long(s).longValue();
 535                                 } catch (NumberFormatException e) {
 536                                 }
 537                         }
 538                         return value;
 539                 }
 540
 541                 /**
 542                  * {@inheritDoc}
 543                  */
 544                 public String getString(String name) {
 545                         String value = (String) fOptions.get(name);
 546                         if (value == null)
 547                                 value = STRING_DEFAULT_DEFAULT;
 548                         return value;
 549                 }
 550
 551                 /**
 552                  * {@inheritDoc}
 553                  */
 554                 public boolean isDefault(String name) {
 555                         return false;
 556                 }
 557
 558                 /**
 559                  * {@inheritDoc}
 560                  */
 561                 public boolean needsSaving() {
 562                         return !fOptions.isEmpty();
 563                 }
 564
 565                 /**
 566                  * {@inheritDoc}
 567                  */
 568                 public void putValue(String name, String value) {
 569                         throw new UnsupportedOperationException();
 570                 }
 571
 572                 /**
 573                  * {@inheritDoc}
 574                  */
 575                 public void setDefault(String name, double value) {
 576                         throw new UnsupportedOperationException();
 577                 }
 578
 579                 /**
 580                  * {@inheritDoc}
 581                  */
 582                 public void setDefault(String name, float value) {
 583                         throw new UnsupportedOperationException();
 584                 }
 585
 586                 /**
 587                  * {@inheritDoc}
 588                  */
 589                 public void setDefault(String name, int value) {
 590                         throw new UnsupportedOperationException();
 591                 }
 592
 593                 /**
 594                  * {@inheritDoc}
 595                  */
 596                 public void setDefault(String name, long value) {
 597                         throw new UnsupportedOperationException();
 598                 }
 599
 600                 /**
 601                  * {@inheritDoc}
 602                  */
 603                 public void setDefault(String name, String defaultObject) {
 604                         throw new UnsupportedOperationException();
 605                 }
 606
 607                 /**
 608                  * {@inheritDoc}
 609                  */
 610                 public void setDefault(String name, boolean value) {
 611                         throw new UnsupportedOperationException();
 612                 }
 613
 614                 /**
 615                  * {@inheritDoc}
 616                  */
 617                 public void setToDefault(String name) {
 618                         throw new UnsupportedOperationException();
 619                 }
 620
 621                 /**
 622                  * {@inheritDoc}
 623                  */
 624                 public void setValue(String name, double value) {
 625                         throw new UnsupportedOperationException();
 626                 }
 627
 628                 /**
 629                  * {@inheritDoc}
 630                  */
 631                 public void setValue(String name, float value) {
 632                         throw new UnsupportedOperationException();
 633                 }
 634
 635                 /**
 636                  * {@inheritDoc}
 637                  */
 638                 public void setValue(String name, int value) {
 639                         throw new UnsupportedOperationException();
 640                 }
 641
 642                 /**
 643                  * {@inheritDoc}
 644                  */
 645                 public void setValue(String name, long value) {
 646                         throw new UnsupportedOperationException();
 647                 }
 648
 649                 /**
 650                  * {@inheritDoc}
 651                  */
 652                 public void setValue(String name, String value) {
 653                         throw new UnsupportedOperationException();
 654                 }
 655
 656                 /**
 657                  * {@inheritDoc}
 658                  */
 659                 public void setValue(String name, boolean value) {
 660                         throw new UnsupportedOperationException();
 661                 }
 662
 663                 /**
 664                  * Returns the adapted options Map.
 665                  *
 666                  * @return Returns the adapted options Map.
 667                  */
 668                 public Map getOptions() {
 669                         return fOptions;
 670                 }
 671
 672                 /**
 673                  * Returns the mock-up preference store, events are received through this
 674                  * preference store.
 675                  *
 676                  * @return Returns the mock-up preference store.
 677                  */
 678                 public IPreferenceStore getMockupPreferenceStore() {
 679                         return fMockupPreferenceStore;
 680                 }
 681
 682                 /**
 683                  * Set the event filter to the given filter.
 684                  *
 685                  * @param filter
 686                  *          The new filter.
 687                  */
 688                 public void setFilter(IPropertyChangeEventFilter filter) {
 689                         fFilter = filter;
 690                 }
 691
 692                 /**
 693                  * Returns the event filter.
 694                  *
 695                  * @return The event filter.
 696                  */
 697                 public IPropertyChangeEventFilter getFilter() {
 698                         return fFilter;
 699                 }
 700         }
 701
 702         /*
 703          * Link mode.
 704          */
 705         // class MouseClickListener implements KeyListener, MouseListener,
 706         // MouseMoveListener, FocusListener, PaintListener,
 707         // IPropertyChangeListener, IDocumentListener, ITextInputListener {
 708         //
 709         // /** The session is active. */
 710         // private boolean fActive;
 711         //
 712         // /** The currently active style range. */
 713         // private IRegion fActiveRegion;
 714         //
 715         // /** The currently active style range as position. */
 716         // private Position fRememberedPosition;
 717         //
 718         // /** The hand cursor. */
 719         // private Cursor fCursor;
 720         //
 721         // /** The link color. */
 722         // private Color fColor;
 723         //
 724         // /** The key modifier mask. */
 725         // private int fKeyModifierMask;
 726         //
 727         // public void deactivate() {
 728         // deactivate(false);
 729         // }
 730         //
 731         // public void deactivate(boolean redrawAll) {
 732         // if (!fActive)
 733         // return;
 734         //
 735         // repairRepresentation(redrawAll);
 736         // fActive = false;
 737         // }
 738         //
 739         // public void install() {
 740         //
 741         // ISourceViewer sourceViewer = getSourceViewer();
 742         // if (sourceViewer == null)
 743         // return;
 744         //
 745         // StyledText text = sourceViewer.getTextWidget();
 746         // if (text == null || text.isDisposed())
 747         // return;
 748         //
 749         // updateColor(sourceViewer);
 750         //
 751         // sourceViewer.addTextInputListener(this);
 752         //
 753         // IDocument document = sourceViewer.getDocument();
 754         // if (document != null)
 755         // document.addDocumentListener(this);
 756         //
 757         // text.addKeyListener(this);
 758         // text.addMouseListener(this);
 759         // text.addMouseMoveListener(this);
 760         // text.addFocusListener(this);
 761         // text.addPaintListener(this);
 762         //
 763         // updateKeyModifierMask();
 764         //
 765         // IPreferenceStore preferenceStore = getPreferenceStore();
 766         // preferenceStore.addPropertyChangeListener(this);
 767         // }
 768         //
 769         // private void updateKeyModifierMask() {
 770         // String modifiers =
 771         // getPreferenceStore().getString(BROWSER_LIKE_LINKS_KEY_MODIFIER);
 772         // fKeyModifierMask = computeStateMask(modifiers);
 773         // if (fKeyModifierMask == -1) {
 774         // // Fallback to stored state mask
 775         // fKeyModifierMask =
 776         // getPreferenceStore().getInt(BROWSER_LIKE_LINKS_KEY_MODIFIER_MASK);
 777         // }
 778         // ;
 779         // }
 780         //
 781         // private int computeStateMask(String modifiers) {
 782         // if (modifiers == null)
 783         // return -1;
 784         //
 785         // if (modifiers.length() == 0)
 786         // return SWT.NONE;
 787         //
 788         // int stateMask = 0;
 789         // StringTokenizer modifierTokenizer = new StringTokenizer(modifiers, ",;.:+-*
 790         // "); //$NON-NLS-1$
 791         // while (modifierTokenizer.hasMoreTokens()) {
 792         // int modifier =
 793         // EditorUtility.findLocalizedModifier(modifierTokenizer.nextToken());
 794         // if (modifier == 0 || (stateMask & modifier) == modifier)
 795         // return -1;
 796         // stateMask = stateMask | modifier;
 797         // }
 798         // return stateMask;
 799         // }
 800         //
 801         // public void uninstall() {
 802         //
 803         // if (fColor != null) {
 804         // fColor.dispose();
 805         // fColor = null;
 806         // }
 807         //
 808         // if (fCursor != null) {
 809         // fCursor.dispose();
 810         // fCursor = null;
 811         // }
 812         //
 813         // ISourceViewer sourceViewer = getSourceViewer();
 814         // if (sourceViewer == null)
 815         // return;
 816         //
 817         // sourceViewer.removeTextInputListener(this);
 818         //
 819         // IDocument document = sourceViewer.getDocument();
 820         // if (document != null)
 821         // document.removeDocumentListener(this);
 822         //
 823         // IPreferenceStore preferenceStore = getPreferenceStore();
 824         // if (preferenceStore != null)
 825         // preferenceStore.removePropertyChangeListener(this);
 826         //
 827         // StyledText text = sourceViewer.getTextWidget();
 828         // if (text == null || text.isDisposed())
 829         // return;
 830         //
 831         // text.removeKeyListener(this);
 832         // text.removeMouseListener(this);
 833         // text.removeMouseMoveListener(this);
 834         // text.removeFocusListener(this);
 835         // text.removePaintListener(this);
 836         // }
 837         //
 838         // /*
 839         // * @see IPropertyChangeListener#propertyChange(PropertyChangeEvent)
 840         // */
 841         // public void propertyChange(PropertyChangeEvent event) {
 842         // if (event.getProperty().equals(PHPEditor.LINK_COLOR)) {
 843         // ISourceViewer viewer = getSourceViewer();
 844         // if (viewer != null)
 845         // updateColor(viewer);
 846         // } else if (event.getProperty().equals(BROWSER_LIKE_LINKS_KEY_MODIFIER)) {
 847         // updateKeyModifierMask();
 848         // }
 849         // }
 850         //
 851         // private void updateColor(ISourceViewer viewer) {
 852         // if (fColor != null)
 853         // fColor.dispose();
 854         //
 855         // StyledText text = viewer.getTextWidget();
 856         // if (text == null || text.isDisposed())
 857         // return;
 858         //
 859         // Display display = text.getDisplay();
 860         // fColor = createColor(getPreferenceStore(), PHPEditor.LINK_COLOR, display);
 861         // }
 862         //
 863         // /**
 864         // * Creates a color from the information stored in the given preference
 865         // store. Returns <code>null</code> if there is no such
 866         // * information available.
 867         // */
 868         // private Color createColor(IPreferenceStore store, String key, Display
 869         // display) {
 870         //
 871         // RGB rgb = null;
 872         //
 873         // if (store.contains(key)) {
 874         //
 875         // if (store.isDefault(key))
 876         // rgb = PreferenceConverter.getDefaultColor(store, key);
 877         // else
 878         // rgb = PreferenceConverter.getColor(store, key);
 879         //
 880         // if (rgb != null)
 881         // return new Color(display, rgb);
 882         // }
 883         //
 884         // return null;
 885         // }
 886         //
 887         // private void repairRepresentation() {
 888         // repairRepresentation(false);
 889         // }
 890         //
 891         // private void repairRepresentation(boolean redrawAll) {
 892         //
 893         // if (fActiveRegion == null)
 894         // return;
 895         //
 896         // ISourceViewer viewer = getSourceViewer();
 897         // if (viewer != null) {
 898         // resetCursor(viewer);
 899         //
 900         // int offset = fActiveRegion.getOffset();
 901         // int length = fActiveRegion.getLength();
 902         //
 903         // // remove style
 904         // if (!redrawAll && viewer instanceof ITextViewerExtension2)
 905         // ((ITextViewerExtension2) viewer).invalidateTextPresentation(offset,
 906         // length);
 907         // else
 908         // viewer.invalidateTextPresentation();
 909         //
 910         // // remove underline
 911         // if (viewer instanceof ITextViewerExtension3) {
 912         // ITextViewerExtension3 extension = (ITextViewerExtension3) viewer;
 913         // offset = extension.modelOffset2WidgetOffset(offset);
 914         // } else {
 915         // offset -= viewer.getVisibleRegion().getOffset();
 916         // }
 917         //
 918         // StyledText text = viewer.getTextWidget();
 919         // try {
 920         // text.redrawRange(offset, length, true);
 921         // } catch (IllegalArgumentException x) {
 922         // PHPeclipsePlugin.log(x);
 923         // }
 924         // }
 925         //
 926         // fActiveRegion = null;
 927         // }
 928         //
 929         // // will eventually be replaced by a method provided by jdt.core
 930         // private IRegion selectWord(IDocument document, int anchor) {
 931         //
 932         // try {
 933         // int offset = anchor;
 934         // char c;
 935         //
 936         // while (offset >= 0) {
 937         // c = document.getChar(offset);
 938         // if (!Scanner.isPHPIdentifierPart(c))
 939         // break;
 940         // --offset;
 941         // }
 942         //
 943         // int start = offset;
 944         //
 945         // offset = anchor;
 946         // int length = document.getLength();
 947         //
 948         // while (offset < length) {
 949         // c = document.getChar(offset);
 950         // if (!Scanner.isPHPIdentifierPart(c))
 951         // break;
 952         // ++offset;
 953         // }
 954         //
 955         // int end = offset;
 956         //
 957         // if (start == end)
 958         // return new Region(start, 0);
 959         // else
 960         // return new Region(start + 1, end - start - 1);
 961         //
 962         // } catch (BadLocationException x) {
 963         // return null;
 964         // }
 965         // }
 966         //
 967         // IRegion getCurrentTextRegion(ISourceViewer viewer) {
 968         //
 969         // int offset = getCurrentTextOffset(viewer);
 970         // if (offset == -1)
 971         // return null;
 972         //
 973         // return null;
 974         // // IJavaElement input= SelectionConverter.getInput(PHPEditor.this);
 975         // // if (input == null)
 976         // // return null;
 977         // //
 978         // // try {
 979         // //
 980         // // IJavaElement[] elements= null;
 981         // // synchronized (input) {
 982         // // elements= ((ICodeAssist) input).codeSelect(offset, 0);
 983         // // }
 984         // //
 985         // // if (elements == null || elements.length == 0)
 986         // // return null;
 987         // //
 988         // // return selectWord(viewer.getDocument(), offset);
 989         // //
 990         // // } catch (JavaModelException e) {
 991         // // return null;
 992         // // }
 993         // }
 994         //
 995         // private int getCurrentTextOffset(ISourceViewer viewer) {
 996         //
 997         // try {
 998         // StyledText text = viewer.getTextWidget();
 999         // if (text == null || text.isDisposed())
1000         // return -1;
1001         //
1002         // Display display = text.getDisplay();
1003         // Point absolutePosition = display.getCursorLocation();
1004         // Point relativePosition = text.toControl(absolutePosition);
1005         //
1006         // int widgetOffset = text.getOffsetAtLocation(relativePosition);
1007         // if (viewer instanceof ITextViewerExtension3) {
1008         // ITextViewerExtension3 extension = (ITextViewerExtension3) viewer;
1009         // return extension.widgetOffset2ModelOffset(widgetOffset);
1010         // } else {
1011         // return widgetOffset + viewer.getVisibleRegion().getOffset();
1012         // }
1013         //
1014         // } catch (IllegalArgumentException e) {
1015         // return -1;
1016         // }
1017         // }
1018         //
1019         // private void highlightRegion(ISourceViewer viewer, IRegion region) {
1020         //
1021         // if (region.equals(fActiveRegion))
1022         // return;
1023         //
1024         // repairRepresentation();
1025         //
1026         // StyledText text = viewer.getTextWidget();
1027         // if (text == null || text.isDisposed())
1028         // return;
1029         //
1030         // // highlight region
1031         // int offset = 0;
1032         // int length = 0;
1033         //
1034         // if (viewer instanceof ITextViewerExtension3) {
1035         // ITextViewerExtension3 extension = (ITextViewerExtension3) viewer;
1036         // IRegion widgetRange = extension.modelRange2WidgetRange(region);
1037         // if (widgetRange == null)
1038         // return;
1039         //
1040         // offset = widgetRange.getOffset();
1041         // length = widgetRange.getLength();
1042         //
1043         // } else {
1044         // offset = region.getOffset() - viewer.getVisibleRegion().getOffset();
1045         // length = region.getLength();
1046         // }
1047         //
1048         // StyleRange oldStyleRange = text.getStyleRangeAtOffset(offset);
1049         // Color foregroundColor = fColor;
1050         // Color backgroundColor = oldStyleRange == null ? text.getBackground() :
1051         // oldStyleRange.background;
1052         // StyleRange styleRange = new StyleRange(offset, length, foregroundColor,
1053         // backgroundColor);
1054         // text.setStyleRange(styleRange);
1055         //
1056         // // underline
1057         // text.redrawRange(offset, length, true);
1058         //
1059         // fActiveRegion = region;
1060         // }
1061         //
1062         // private void activateCursor(ISourceViewer viewer) {
1063         // StyledText text = viewer.getTextWidget();
1064         // if (text == null || text.isDisposed())
1065         // return;
1066         // Display display = text.getDisplay();
1067         // if (fCursor == null)
1068         // fCursor = new Cursor(display, SWT.CURSOR_HAND);
1069         // text.setCursor(fCursor);
1070         // }
1071         //
1072         // private void resetCursor(ISourceViewer viewer) {
1073         // StyledText text = viewer.getTextWidget();
1074         // if (text != null && !text.isDisposed())
1075         // text.setCursor(null);
1076         //
1077         // if (fCursor != null) {
1078         // fCursor.dispose();
1079         // fCursor = null;
1080         // }
1081         // }
1082         //
1083         // /*
1084         // * @see
1085         // org.eclipse.swt.events.KeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)
1086         // */
1087         // public void keyPressed(KeyEvent event) {
1088         //
1089         // if (fActive) {
1090         // deactivate();
1091         // return;
1092         // }
1093         //
1094         // if (event.keyCode != fKeyModifierMask) {
1095         // deactivate();
1096         // return;
1097         // }
1098         //
1099         // fActive = true;
1100         //
1101         // // removed for #25871
1102         // //
1103         // // ISourceViewer viewer= getSourceViewer();
1104         // // if (viewer == null)
1105         // // return;
1106         // //
1107         // // IRegion region= getCurrentTextRegion(viewer);
1108         // // if (region == null)
1109         // // return;
1110         // //
1111         // // highlightRegion(viewer, region);
1112         // // activateCursor(viewer);
1113         // }
1114         //
1115         // /*
1116         // * @see
1117         // org.eclipse.swt.events.KeyListener#keyReleased(org.eclipse.swt.events.KeyEvent)
1118         // */
1119         // public void keyReleased(KeyEvent event) {
1120         //
1121         // if (!fActive)
1122         // return;
1123         //
1124         // deactivate();
1125         // }
1126         //
1127         // /*
1128         // * @see
1129         // org.eclipse.swt.events.MouseListener#mouseDoubleClick(org.eclipse.swt.events.MouseEvent)
1130         // */
1131         // public void mouseDoubleClick(MouseEvent e) {
1132         // }
1133         //
1134         // /*
1135         // * @see
1136         // org.eclipse.swt.events.MouseListener#mouseDown(org.eclipse.swt.events.MouseEvent)
1137         // */
1138         // public void mouseDown(MouseEvent event) {
1139         //
1140         // if (!fActive)
1141         // return;
1142         //
1143         // if (event.stateMask != fKeyModifierMask) {
1144         // deactivate();
1145         // return;
1146         // }
1147         //
1148         // if (event.button != 1) {
1149         // deactivate();
1150         // return;
1151         // }
1152         // }
1153         //
1154         // /*
1155         // * @see
1156         // org.eclipse.swt.events.MouseListener#mouseUp(org.eclipse.swt.events.MouseEvent)
1157         // */
1158         // public void mouseUp(MouseEvent e) {
1159         //
1160         // if (!fActive)
1161         // return;
1162         //
1163         // if (e.button != 1) {
1164         // deactivate();
1165         // return;
1166         // }
1167         //
1168         // boolean wasActive = fCursor != null;
1169         //
1170         // deactivate();
1171         //
1172         // if (wasActive) {
1173         // IAction action = getAction("OpenEditor"); //$NON-NLS-1$
1174         // if (action != null)
1175         // action.run();
1176         // }
1177         // }
1178         //
1179         // /*
1180         // * @see
1181         // org.eclipse.swt.events.MouseMoveListener#mouseMove(org.eclipse.swt.events.MouseEvent)
1182         // */
1183         // public void mouseMove(MouseEvent event) {
1184         //
1185         // if (event.widget instanceof Control && !((Control)
1186         // event.widget).isFocusControl()) {
1187         // deactivate();
1188         // return;
1189         // }
1190         //
1191         // if (!fActive) {
1192         // if (event.stateMask != fKeyModifierMask)
1193         // return;
1194         // // modifier was already pressed
1195         // fActive = true;
1196         // }
1197         //
1198         // ISourceViewer viewer = getSourceViewer();
1199         // if (viewer == null) {
1200         // deactivate();
1201         // return;
1202         // }
1203         //
1204         // StyledText text = viewer.getTextWidget();
1205         // if (text == null || text.isDisposed()) {
1206         // deactivate();
1207         // return;
1208         // }
1209         //
1210         // if ((event.stateMask & SWT.BUTTON1) != 0 && text.getSelectionCount() != 0)
1211         // {
1212         // deactivate();
1213         // return;
1214         // }
1215         //
1216         // IRegion region = getCurrentTextRegion(viewer);
1217         // if (region == null || region.getLength() == 0) {
1218         // repairRepresentation();
1219         // return;
1220         // }
1221         //
1222         // highlightRegion(viewer, region);
1223         // activateCursor(viewer);
1224         // }
1225         //
1226         // /*
1227         // * @see
1228         // org.eclipse.swt.events.FocusListener#focusGained(org.eclipse.swt.events.FocusEvent)
1229         // */
1230         // public void focusGained(FocusEvent e) {
1231         // }
1232         //
1233         // /*
1234         // * @see
1235         // org.eclipse.swt.events.FocusListener#focusLost(org.eclipse.swt.events.FocusEvent)
1236         // */
1237         // public void focusLost(FocusEvent event) {
1238         // deactivate();
1239         // }
1240         //
1241         // /*
1242         // * @see
1243         // org.eclipse.jface.text.IDocumentListener#documentAboutToBeChanged(org.eclipse.jface.text.DocumentEvent)
1244         // */
1245         // public void documentAboutToBeChanged(DocumentEvent event) {
1246         // if (fActive && fActiveRegion != null) {
1247         // fRememberedPosition = new Position(fActiveRegion.getOffset(),
1248         // fActiveRegion.getLength());
1249         // try {
1250         // event.getDocument().addPosition(fRememberedPosition);
1251         // } catch (BadLocationException x) {
1252         // fRememberedPosition = null;
1253         // }
1254         // }
1255         // }
1256         //
1257         // /*
1258         // * @see
1259         // org.eclipse.jface.text.IDocumentListener#documentChanged(org.eclipse.jface.text.DocumentEvent)
1260         // */
1261         // public void documentChanged(DocumentEvent event) {
1262         // if (fRememberedPosition != null && !fRememberedPosition.isDeleted()) {
1263         // event.getDocument().removePosition(fRememberedPosition);
1264         // fActiveRegion = new Region(fRememberedPosition.getOffset(),
1265         // fRememberedPosition.getLength());
1266         // }
1267         // fRememberedPosition = null;
1268         //
1269         // ISourceViewer viewer = getSourceViewer();
1270         // if (viewer != null) {
1271         // StyledText widget = viewer.getTextWidget();
1272         // if (widget != null && !widget.isDisposed()) {
1273         // widget.getDisplay().asyncExec(new Runnable() {
1274         // public void run() {
1275         // deactivate();
1276         // }
1277         // });
1278         // }
1279         // }
1280         // }
1281         //
1282         // /*
1283         // * @see
1284         // org.eclipse.jface.text.ITextInputListener#inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument,
1285         // * org.eclipse.jface.text.IDocument)
1286         // */
1287         // public void inputDocumentAboutToBeChanged(IDocument oldInput, IDocument
1288         // newInput) {
1289         // if (oldInput == null)
1290         // return;
1291         // deactivate();
1292         // oldInput.removeDocumentListener(this);
1293         // }
1294         //
1295         // /*
1296         // * @see
1297         // org.eclipse.jface.text.ITextInputListener#inputDocumentChanged(org.eclipse.jface.text.IDocument,
1298         // * org.eclipse.jface.text.IDocument)
1299         // */
1300         // public void inputDocumentChanged(IDocument oldInput, IDocument newInput) {
1301         // if (newInput == null)
1302         // return;
1303         // newInput.addDocumentListener(this);
1304         // }
1305         //
1306         // /*
1307         // * @see PaintListener#paintControl(PaintEvent)
1308         // */
1309         // public void paintControl(PaintEvent event) {
1310         // if (fActiveRegion == null)
1311         // return;
1312         //
1313         // ISourceViewer viewer = getSourceViewer();
1314         // if (viewer == null)
1315         // return;
1316         //
1317         // StyledText text = viewer.getTextWidget();
1318         // if (text == null || text.isDisposed())
1319         // return;
1320         //
1321         // int offset = 0;
1322         // int length = 0;
1323         //
1324         // if (viewer instanceof ITextViewerExtension3) {
1325         //
1326         // ITextViewerExtension3 extension = (ITextViewerExtension3) viewer;
1327         // IRegion widgetRange = extension.modelRange2WidgetRange(new Region(offset,
1328         // length));
1329         // if (widgetRange == null)
1330         // return;
1331         //
1332         // offset = widgetRange.getOffset();
1333         // length = widgetRange.getLength();
1334         //
1335         // } else {
1336         //
1337         // IRegion region = viewer.getVisibleRegion();
1338         // if (!includes(region, fActiveRegion))
1339         // return;
1340         //
1341         // offset = fActiveRegion.getOffset() - region.getOffset();
1342         // length = fActiveRegion.getLength();
1343         // }
1344         //
1345         // // support for bidi
1346         // Point minLocation = getMinimumLocation(text, offset, length);
1347         // Point maxLocation = getMaximumLocation(text, offset, length);
1348         //
1349         // int x1 = minLocation.x;
1350         // int x2 = minLocation.x + maxLocation.x - minLocation.x - 1;
1351         // int y = minLocation.y + text.getLineHeight() - 1;
1352         //
1353         // GC gc = event.gc;
1354         // if (fColor != null && !fColor.isDisposed())
1355         // gc.setForeground(fColor);
1356         // gc.drawLine(x1, y, x2, y);
1357         // }
1358         //
1359         // private boolean includes(IRegion region, IRegion position) {
1360         // return position.getOffset() >= region.getOffset()
1361         // && position.getOffset() + position.getLength() <= region.getOffset() +
1362         // region.getLength();
1363         // }
1364         //
1365         // private Point getMinimumLocation(StyledText text, int offset, int length) {
1366         // Point minLocation = new Point(Integer.MAX_VALUE, Integer.MAX_VALUE);
1367         //
1368         // for (int i = 0; i <= length; i++) {
1369         // Point location = text.getLocationAtOffset(offset + i);
1370         //
1371         // if (location.x < minLocation.x)
1372         // minLocation.x = location.x;
1373         // if (location.y < minLocation.y)
1374         // minLocation.y = location.y;
1375         // }
1376         //
1377         // return minLocation;
1378         // }
1379         //
1380         // private Point getMaximumLocation(StyledText text, int offset, int length) {
1381         // Point maxLocation = new Point(Integer.MIN_VALUE, Integer.MIN_VALUE);
1382         //
1383         // for (int i = 0; i <= length; i++) {
1384         // Point location = text.getLocationAtOffset(offset + i);
1385         //
1386         // if (location.x > maxLocation.x)
1387         // maxLocation.x = location.x;
1388         // if (location.y > maxLocation.y)
1389         // maxLocation.y = location.y;
1390         // }
1391         //
1392         // return maxLocation;
1393         // }
1394         // };
1395         /*
1396          * Link mode.
1397          */
1398         class MouseClickListener implements KeyListener, MouseListener, MouseMoveListener, FocusListener, PaintListener,
1399                         IPropertyChangeListener, IDocumentListener, ITextInputListener, ITextPresentationListener {
1400
1401                 /** The session is active. */
1402                 private boolean fActive;
1403
1404                 /** The currently active style range. */
1405                 private IRegion fActiveRegion;
1406
1407                 /** The currently active style range as position. */
1408                 private Position fRememberedPosition;
1409
1410                 /** The hand cursor. */
1411                 private Cursor fCursor;
1412
1413                 /** The link color. */
1414                 private Color fColor;
1415
1416                 /** The key modifier mask. */
1417                 private int fKeyModifierMask;
1418
1419                 public void deactivate() {
1420                         deactivate(false);
1421                 }
1422
1423                 public void deactivate(boolean redrawAll) {
1424                         if (!fActive)
1425                                 return;
1426
1427                         repairRepresentation(redrawAll);
1428                         fActive = false;
1429                 }
1430
1431                 public void install() {
1432                         ISourceViewer sourceViewer = getSourceViewer();
1433                         if (sourceViewer == null)
1434                                 return;
1435
1436                         StyledText text = sourceViewer.getTextWidget();
1437                         if (text == null || text.isDisposed())
1438                                 return;
1439
1440                         updateColor(sourceViewer);
1441
1442                         sourceViewer.addTextInputListener(this);
1443
1444                         IDocument document = sourceViewer.getDocument();
1445                         if (document != null)
1446                                 document.addDocumentListener(this);
1447
1448                         text.addKeyListener(this);
1449                         text.addMouseListener(this);
1450                         text.addMouseMoveListener(this);
1451                         text.addFocusListener(this);
1452                         text.addPaintListener(this);
1453
1454                         ((ITextViewerExtension4) sourceViewer).addTextPresentationListener(this);
1455
1456                         updateKeyModifierMask();
1457
1458                         IPreferenceStore preferenceStore = getPreferenceStore();
1459                         preferenceStore.addPropertyChangeListener(this);
1460                 }
1461
1462                 private void updateKeyModifierMask() {
1463                         String modifiers = getPreferenceStore().getString(BROWSER_LIKE_LINKS_KEY_MODIFIER);
1464                         fKeyModifierMask = computeStateMask(modifiers);
1465                         if (fKeyModifierMask == -1) {
1466                                 // Fall back to stored state mask
1467                                 fKeyModifierMask = getPreferenceStore().getInt(BROWSER_LIKE_LINKS_KEY_MODIFIER_MASK);
1468                         }
1469                 }
1470
1471                 private int computeStateMask(String modifiers) {
1472                         if (modifiers == null)
1473                                 return -1;
1474
1475                         if (modifiers.length() == 0)
1476                                 return SWT.NONE;
1477
1478                         int stateMask = 0;
1479                         StringTokenizer modifierTokenizer = new StringTokenizer(modifiers, ",;.:+-* "); //$NON-NLS-1$
1480                         while (modifierTokenizer.hasMoreTokens()) {
1481                                 int modifier = EditorUtility.findLocalizedModifier(modifierTokenizer.nextToken());
1482                                 if (modifier == 0 || (stateMask & modifier) == modifier)
1483                                         return -1;
1484                                 stateMask = stateMask | modifier;
1485                         }
1486                         return stateMask;
1487                 }
1488
1489                 public void uninstall() {
1490
1491                         if (fColor != null) {
1492                                 fColor.dispose();
1493                                 fColor = null;
1494                         }
1495
1496                         if (fCursor != null) {
1497                                 fCursor.dispose();
1498                                 fCursor = null;
1499                         }
1500
1501                         ISourceViewer sourceViewer = getSourceViewer();
1502                         if (sourceViewer != null)
1503                                 sourceViewer.removeTextInputListener(this);
1504
1505                         IDocumentProvider documentProvider = getDocumentProvider();
1506                         if (documentProvider != null) {
1507                                 IDocument document = documentProvider.getDocument(getEditorInput());
1508                                 if (document != null)
1509                                         document.removeDocumentListener(this);
1510                         }
1511
1512                         IPreferenceStore preferenceStore = getPreferenceStore();
1513                         if (preferenceStore != null)
1514                                 preferenceStore.removePropertyChangeListener(this);
1515
1516                         if (sourceViewer == null)
1517                                 return;
1518
1519                         StyledText text = sourceViewer.getTextWidget();
1520                         if (text == null || text.isDisposed())
1521                                 return;
1522
1523                         text.removeKeyListener(this);
1524                         text.removeMouseListener(this);
1525                         text.removeMouseMoveListener(this);
1526                         text.removeFocusListener(this);
1527                         text.removePaintListener(this);
1528
1529                         ((ITextViewerExtension4) sourceViewer).removeTextPresentationListener(this);
1530                 }
1531
1532                 /*
1533                  * @see IPropertyChangeListener#propertyChange(PropertyChangeEvent)
1534                  */
1535                 public void propertyChange(PropertyChangeEvent event) {
1536                         if (event.getProperty().equals(PHPEditor.LINK_COLOR)) {
1537                                 ISourceViewer viewer = getSourceViewer();
1538                                 if (viewer != null)
1539                                         updateColor(viewer);
1540                         } else if (event.getProperty().equals(BROWSER_LIKE_LINKS_KEY_MODIFIER)) {
1541                                 updateKeyModifierMask();
1542                         }
1543                 }
1544
1545                 private void updateColor(ISourceViewer viewer) {
1546                         if (fColor != null)
1547                                 fColor.dispose();
1548
1549                         StyledText text = viewer.getTextWidget();
1550                         if (text == null || text.isDisposed())
1551                                 return;
1552
1553                         Display display = text.getDisplay();
1554                         fColor = createColor(getPreferenceStore(), PHPEditor.LINK_COLOR, display);
1555                 }
1556
1557                 /**
1558                  * Creates a color from the information stored in the given preference
1559                  * store.
1560                  *
1561                  * @param store
1562                  *          the preference store
1563                  * @param key
1564                  *          the key
1565                  * @param display
1566                  *          the display
1567                  * @return the color or <code>null</code> if there is no such information
1568                  *         available
1569                  */
1570                 private Color createColor(IPreferenceStore store, String key, Display display) {
1571
1572                         RGB rgb = null;
1573
1574                         if (store.contains(key)) {
1575
1576                                 if (store.isDefault(key))
1577                                         rgb = PreferenceConverter.getDefaultColor(store, key);
1578                                 else
1579                                         rgb = PreferenceConverter.getColor(store, key);
1580
1581                                 if (rgb != null)
1582                                         return new Color(display, rgb);
1583                         }
1584
1585                         return null;
1586                 }
1587
1588                 private void repairRepresentation() {
1589                         repairRepresentation(false);
1590                 }
1591
1592                 private void repairRepresentation(boolean redrawAll) {
1593
1594                         if (fActiveRegion == null)
1595                                 return;
1596
1597                         int offset = fActiveRegion.getOffset();
1598                         int length = fActiveRegion.getLength();
1599                         fActiveRegion = null;
1600
1601                         ISourceViewer viewer = getSourceViewer();
1602                         if (viewer != null) {
1603
1604                                 resetCursor(viewer);
1605
1606                                 // Invalidate ==> remove applied text presentation
1607                                 if (!redrawAll && viewer instanceof ITextViewerExtension2)
1608                                         ((ITextViewerExtension2) viewer).invalidateTextPresentation(offset, length);
1609                                 else
1610                                         viewer.invalidateTextPresentation();
1611
1612                                 // Remove underline
1613                                 if (viewer instanceof ITextViewerExtension5) {
1614                                         ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
1615                                         offset = extension.modelOffset2WidgetOffset(offset);
1616                                 } else {
1617                                         offset -= viewer.getVisibleRegion().getOffset();
1618                                 }
1619                                 try {
1620                                         StyledText text = viewer.getTextWidget();
1621
1622                                         text.redrawRange(offset, length, false);
1623                                 } catch (IllegalArgumentException x) {
1624                                         // JavaPlugin.log(x);
1625                                 }
1626                         }
1627                 }
1628
1629                 // will eventually be replaced by a method provided by jdt.core
1630                 private IRegion selectWord(IDocument document, int anchor) {
1631
1632                         try {
1633                                 int offset = anchor;
1634                                 char c;
1635
1636                                 while (offset >= 0) {
1637                                         c = document.getChar(offset);
1638                                         if (!Scanner.isPHPIdentifierPart(c) && c != '$')
1639                                                 break;
1640                                         --offset;
1641                                 }
1642
1643                                 int start = offset;
1644
1645                                 offset = anchor;
1646                                 int length = document.getLength();
1647
1648                                 while (offset < length) {
1649                                         c = document.getChar(offset);
1650                                         if (!Scanner.isPHPIdentifierPart(c) && c != '$')
1651                                                 break;
1652                                         ++offset;
1653                                 }
1654
1655                                 int end = offset;
1656
1657                                 if (start == end)
1658                                         return new Region(start, 0);
1659                                 else
1660                                         return new Region(start + 1, end - start - 1);
1661
1662                         } catch (BadLocationException x) {
1663                                 return null;
1664                         }
1665                 }
1666
1667                 IRegion getCurrentTextRegion(ISourceViewer viewer) {
1668
1669                         int offset = getCurrentTextOffset(viewer);
1670                         if (offset == -1)
1671                                 return null;
1672
1673                         IJavaElement input = SelectionConverter.getInput(PHPEditor.this);
1674                         if (input == null)
1675                                 return null;
1676
1677                         // try {
1678
1679                         // IJavaElement[] elements= null;
1680                         // synchronized (input) {
1681                         // elements= ((ICodeAssist) input).codeSelect(offset, 0);
1682                         // }
1683                         //
1684                         // if (elements == null || elements.length == 0)
1685                         // return null;
1686
1687                         return selectWord(viewer.getDocument(), offset);
1688
1689                         // } catch (JavaModelException e) {
1690                         // return null;
1691                         // }
1692                 }
1693
1694                 private int getCurrentTextOffset(ISourceViewer viewer) {
1695
1696                         try {
1697                                 StyledText text = viewer.getTextWidget();
1698                                 if (text == null || text.isDisposed())
1699                                         return -1;
1700
1701                                 Display display = text.getDisplay();
1702                                 Point absolutePosition = display.getCursorLocation();
1703                                 Point relativePosition = text.toControl(absolutePosition);
1704
1705                                 int widgetOffset = text.getOffsetAtLocation(relativePosition);
1706                                 if (viewer instanceof ITextViewerExtension5) {
1707                                         ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
1708                                         return extension.widgetOffset2ModelOffset(widgetOffset);
1709                                 } else {
1710                                         return widgetOffset + viewer.getVisibleRegion().getOffset();
1711                                 }
1712
1713                         } catch (IllegalArgumentException e) {
1714                                 return -1;
1715                         }
1716                 }
1717
1718                 public void applyTextPresentation(TextPresentation textPresentation) {
1719                         if (fActiveRegion == null)
1720                                 return;
1721                         IRegion region = textPresentation.getExtent();
1722                         if (fActiveRegion.getOffset() + fActiveRegion.getLength() >= region.getOffset()
1723                                         && region.getOffset() + region.getLength() > fActiveRegion.getOffset())
1724                                 textPresentation.mergeStyleRange(new StyleRange(fActiveRegion.getOffset(), fActiveRegion.getLength(), fColor, null));
1725                 }
1726
1727                 private void highlightRegion(ISourceViewer viewer, IRegion region) {
1728
1729                         if (region.equals(fActiveRegion))
1730                                 return;
1731
1732                         repairRepresentation();
1733
1734                         StyledText text = viewer.getTextWidget();
1735                         if (text == null || text.isDisposed())
1736                                 return;
1737
1738                         // Underline
1739                         int offset = 0;
1740                         int length = 0;
1741                         if (viewer instanceof ITextViewerExtension5) {
1742                                 ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
1743                                 IRegion widgetRange = extension.modelRange2WidgetRange(region);
1744                                 if (widgetRange == null)
1745                                         return;
1746
1747                                 offset = widgetRange.getOffset();
1748                                 length = widgetRange.getLength();
1749
1750                         } else {
1751                                 offset = region.getOffset() - viewer.getVisibleRegion().getOffset();
1752                                 length = region.getLength();
1753                         }
1754                         text.redrawRange(offset, length, false);
1755
1756                         // Invalidate region ==> apply text presentation
1757                         fActiveRegion = region;
1758                         if (viewer instanceof ITextViewerExtension2)
1759                                 ((ITextViewerExtension2) viewer).invalidateTextPresentation(region.getOffset(), region.getLength());
1760                         else
1761                                 viewer.invalidateTextPresentation();
1762                 }
1763
1764                 private void activateCursor(ISourceViewer viewer) {
1765                         StyledText text = viewer.getTextWidget();
1766                         if (text == null || text.isDisposed())
1767                                 return;
1768                         Display display = text.getDisplay();
1769                         if (fCursor == null)
1770                                 fCursor = new Cursor(display, SWT.CURSOR_HAND);
1771                         text.setCursor(fCursor);
1772                 }
1773
1774                 private void resetCursor(ISourceViewer viewer) {
1775                         StyledText text = viewer.getTextWidget();
1776                         if (text != null && !text.isDisposed())
1777                                 text.setCursor(null);
1778
1779                         if (fCursor != null) {
1780                                 fCursor.dispose();
1781                                 fCursor = null;
1782                         }
1783                 }
1784
1785                 /*
1786                  * @see org.eclipse.swt.events.KeyListener#keyPressed(org.eclipse.swt.events.KeyEvent)
1787                  */
1788                 public void keyPressed(KeyEvent event) {
1789
1790                         if (fActive) {
1791                                 deactivate();
1792                                 return;
1793                         }
1794
1795                         if (event.keyCode != fKeyModifierMask) {
1796                                 deactivate();
1797                                 return;
1798                         }
1799
1800                         fActive = true;
1801
1802                         // removed for #25871
1803                         //
1804                         // ISourceViewer viewer= getSourceViewer();
1805                         // if (viewer == null)
1806                         // return;
1807                         //
1808                         // IRegion region= getCurrentTextRegion(viewer);
1809                         // if (region == null)
1810                         // return;
1811                         //
1812                         // highlightRegion(viewer, region);
1813                         // activateCursor(viewer);
1814                 }
1815
1816                 /*
1817                  * @see org.eclipse.swt.events.KeyListener#keyReleased(org.eclipse.swt.events.KeyEvent)
1818                  */
1819                 public void keyReleased(KeyEvent event) {
1820
1821                         if (!fActive)
1822                                 return;
1823
1824                         deactivate();
1825                 }
1826
1827                 /*
1828                  * @see org.eclipse.swt.events.MouseListener#mouseDoubleClick(org.eclipse.swt.events.MouseEvent)
1829                  */
1830                 public void mouseDoubleClick(MouseEvent e) {
1831                 }
1832
1833                 /*
1834                  * @see org.eclipse.swt.events.MouseListener#mouseDown(org.eclipse.swt.events.MouseEvent)
1835                  */
1836                 public void mouseDown(MouseEvent event) {
1837
1838                         if (!fActive)
1839                                 return;
1840
1841                         if (event.stateMask != fKeyModifierMask) {
1842                                 deactivate();
1843                                 return;
1844                         }
1845
1846                         if (event.button != 1) {
1847                                 deactivate();
1848                                 return;
1849                         }
1850                 }
1851
1852                 /*
1853                  * @see org.eclipse.swt.events.MouseListener#mouseUp(org.eclipse.swt.events.MouseEvent)
1854                  */
1855                 public void mouseUp(MouseEvent e) {
1856
1857                         if (!fActive)
1858                                 return;
1859
1860                         if (e.button != 1) {
1861                                 deactivate();
1862                                 return;
1863                         }
1864
1865                         boolean wasActive = fCursor != null;
1866
1867                         deactivate();
1868
1869                         if (wasActive) {
1870                                 IAction action = getAction("OpenEditor"); //$NON-NLS-1$
1871                                 if (action != null)
1872                                         action.run();
1873                         }
1874                 }
1875
1876                 /*
1877                  * @see org.eclipse.swt.events.MouseMoveListener#mouseMove(org.eclipse.swt.events.MouseEvent)
1878                  */
1879                 public void mouseMove(MouseEvent event) {
1880
1881                         if (event.widget instanceof Control && !((Control) event.widget).isFocusControl()) {
1882                                 deactivate();
1883                                 return;
1884                         }
1885
1886                         if (!fActive) {
1887                                 if (event.stateMask != fKeyModifierMask)
1888                                         return;
1889                                 // modifier was already pressed
1890                                 fActive = true;
1891                         }
1892
1893                         ISourceViewer viewer = getSourceViewer();
1894                         if (viewer == null) {
1895                                 deactivate();
1896                                 return;
1897                         }
1898
1899                         StyledText text = viewer.getTextWidget();
1900                         if (text == null || text.isDisposed()) {
1901                                 deactivate();
1902                                 return;
1903                         }
1904
1905                         if ((event.stateMask & SWT.BUTTON1) != 0 && text.getSelectionCount() != 0) {
1906                                 deactivate();
1907                                 return;
1908                         }
1909
1910                         IRegion region = getCurrentTextRegion(viewer);
1911                         if (region == null || region.getLength() == 0) {
1912                                 repairRepresentation();
1913                                 return;
1914                         }
1915
1916                         highlightRegion(viewer, region);
1917                         activateCursor(viewer);
1918                 }
1919
1920                 /*
1921                  * @see org.eclipse.swt.events.FocusListener#focusGained(org.eclipse.swt.events.FocusEvent)
1922                  */
1923                 public void focusGained(FocusEvent e) {
1924                 }
1925
1926                 /*
1927                  * @see org.eclipse.swt.events.FocusListener#focusLost(org.eclipse.swt.events.FocusEvent)
1928                  */
1929                 public void focusLost(FocusEvent event) {
1930                         deactivate();
1931                 }
1932
1933                 /*
1934                  * @see org.eclipse.jface.text.IDocumentListener#documentAboutToBeChanged(org.eclipse.jface.text.DocumentEvent)
1935                  */
1936                 public void documentAboutToBeChanged(DocumentEvent event) {
1937                         if (fActive && fActiveRegion != null) {
1938                                 fRememberedPosition = new Position(fActiveRegion.getOffset(), fActiveRegion.getLength());
1939                                 try {
1940                                         event.getDocument().addPosition(fRememberedPosition);
1941                                 } catch (BadLocationException x) {
1942                                         fRememberedPosition = null;
1943                                 }
1944                         }
1945                 }
1946
1947                 /*
1948                  * @see org.eclipse.jface.text.IDocumentListener#documentChanged(org.eclipse.jface.text.DocumentEvent)
1949                  */
1950                 public void documentChanged(DocumentEvent event) {
1951                         if (fRememberedPosition != null) {
1952                                 if (!fRememberedPosition.isDeleted()) {
1953
1954                                         event.getDocument().removePosition(fRememberedPosition);
1955                                         fActiveRegion = new Region(fRememberedPosition.getOffset(), fRememberedPosition.getLength());
1956                                         fRememberedPosition = null;
1957
1958                                         ISourceViewer viewer = getSourceViewer();
1959                                         if (viewer != null) {
1960                                                 StyledText widget = viewer.getTextWidget();
1961                                                 if (widget != null && !widget.isDisposed()) {
1962                                                         widget.getDisplay().asyncExec(new Runnable() {
1963                                                                 public void run() {
1964                                                                         deactivate();
1965                                                                 }
1966                                                         });
1967                                                 }
1968                                         }
1969
1970                                 } else {
1971                                         fActiveRegion = null;
1972                                         fRememberedPosition = null;
1973                                         deactivate();
1974                                 }
1975                         }
1976                 }
1977
1978                 /*
1979                  * @see org.eclipse.jface.text.ITextInputListener#inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument,
1980                  *      org.eclipse.jface.text.IDocument)
1981                  */
1982                 public void inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput) {
1983                         if (oldInput == null)
1984                                 return;
1985                         deactivate();
1986                         oldInput.removeDocumentListener(this);
1987                 }
1988
1989                 /*
1990                  * @see org.eclipse.jface.text.ITextInputListener#inputDocumentChanged(org.eclipse.jface.text.IDocument,
1991                  *      org.eclipse.jface.text.IDocument)
1992                  */
1993                 public void inputDocumentChanged(IDocument oldInput, IDocument newInput) {
1994                         if (newInput == null)
1995                                 return;
1996                         newInput.addDocumentListener(this);
1997                 }
1998
1999                 /*
2000                  * @see PaintListener#paintControl(PaintEvent)
2001                  */
2002                 public void paintControl(PaintEvent event) {
2003                         if (fActiveRegion == null)
2004                                 return;
2005
2006                         ISourceViewer viewer = getSourceViewer();
2007                         if (viewer == null)
2008                                 return;
2009
2010                         StyledText text = viewer.getTextWidget();
2011                         if (text == null || text.isDisposed())
2012                                 return;
2013
2014                         int offset = 0;
2015                         int length = 0;
2016
2017                         if (viewer instanceof ITextViewerExtension5) {
2018
2019                                 ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
2020                                 IRegion widgetRange = extension.modelRange2WidgetRange(fActiveRegion);
2021                                 if (widgetRange == null)
2022                                         return;
2023
2024                                 offset = widgetRange.getOffset();
2025                                 length = widgetRange.getLength();
2026
2027                         } else {
2028
2029                                 IRegion region = viewer.getVisibleRegion();
2030                                 if (!includes(region, fActiveRegion))
2031                                         return;
2032
2033                                 offset = fActiveRegion.getOffset() - region.getOffset();
2034                                 length = fActiveRegion.getLength();
2035                         }
2036
2037                         // support for bidi
2038                         Point minLocation = getMinimumLocation(text, offset, length);
2039                         Point maxLocation = getMaximumLocation(text, offset, length);
2040
2041                         int x1 = minLocation.x;
2042                         int x2 = minLocation.x + maxLocation.x - minLocation.x - 1;
2043                         int y = minLocation.y + text.getLineHeight() - 1;
2044
2045                         GC gc = event.gc;
2046                         if (fColor != null && !fColor.isDisposed())
2047                                 gc.setForeground(fColor);
2048                         gc.drawLine(x1, y, x2, y);
2049                 }
2050
2051                 private boolean includes(IRegion region, IRegion position) {
2052                         return position.getOffset() >= region.getOffset()
2053                                         && position.getOffset() + position.getLength() <= region.getOffset() + region.getLength();
2054                 }
2055
2056                 private Point getMinimumLocation(StyledText text, int offset, int length) {
2057                         Point minLocation = new Point(Integer.MAX_VALUE, Integer.MAX_VALUE);
2058
2059                         for (int i = 0; i <= length; i++) {
2060                                 Point location = text.getLocationAtOffset(offset + i);
2061
2062                                 if (location.x < minLocation.x)
2063                                         minLocation.x = location.x;
2064                                 if (location.y < minLocation.y)
2065                                         minLocation.y = location.y;
2066                         }
2067
2068                         return minLocation;
2069                 }
2070
2071                 private Point getMaximumLocation(StyledText text, int offset, int length) {
2072                         Point maxLocation = new Point(Integer.MIN_VALUE, Integer.MIN_VALUE);
2073
2074                         for (int i = 0; i <= length; i++) {
2075                                 Point location = text.getLocationAtOffset(offset + i);
2076
2077                                 if (location.x > maxLocation.x)
2078                                         maxLocation.x = location.x;
2079                                 if (location.y > maxLocation.y)
2080                                         maxLocation.y = location.y;
2081                         }
2082
2083                         return maxLocation;
2084                 }
2085         }
2086
2087         /**
2088          * This action dispatches into two behaviours: If there is no current text
2089          * hover, the javadoc is displayed using information presenter. If there is a
2090          * current text hover, it is converted into a information presenter in order
2091          * to make it sticky.
2092          */
2093         class InformationDispatchAction extends TextEditorAction {
2094
2095                 /** The wrapped text operation action. */
2096                 private final TextOperationAction fTextOperationAction;
2097
2098                 /**
2099                  * Creates a dispatch action.
2100                  */
2101                 public InformationDispatchAction(ResourceBundle resourceBundle, String prefix, final TextOperationAction textOperationAction) {
2102                         super(resourceBundle, prefix, PHPEditor.this);
2103                         if (textOperationAction == null)
2104                                 throw new IllegalArgumentException();
2105                         fTextOperationAction = textOperationAction;
2106                 }
2107
2108                 /*
2109                  * @see org.eclipse.jface.action.IAction#run()
2110                  */
2111                 public void run() {
2112
2113                         ISourceViewer sourceViewer = getSourceViewer();
2114                         if (sourceViewer == null) {
2115                                 fTextOperationAction.run();
2116                                 return;
2117                         }
2118
2119                         if (!(sourceViewer instanceof ITextViewerExtension2)) {
2120                                 fTextOperationAction.run();
2121                                 return;
2122                         }
2123
2124                         ITextViewerExtension2 textViewerExtension2 = (ITextViewerExtension2) sourceViewer;
2125
2126                         // does a text hover exist?
2127                         ITextHover textHover = textViewerExtension2.getCurrentTextHover();
2128                         if (textHover == null) {
2129                                 fTextOperationAction.run();
2130                                 return;
2131                         }
2132
2133                         Point hoverEventLocation = textViewerExtension2.getHoverEventLocation();
2134                         int offset = computeOffsetAtLocation(sourceViewer, hoverEventLocation.x, hoverEventLocation.y);
2135                         if (offset == -1) {
2136                                 fTextOperationAction.run();
2137                                 return;
2138                         }
2139
2140                         try {
2141                                 // get the text hover content
2142                                 IDocument document = sourceViewer.getDocument();
2143                                 String contentType = document.getContentType(offset);
2144
2145                                 final IRegion hoverRegion = textHover.getHoverRegion(sourceViewer, offset);
2146                                 if (hoverRegion == null)
2147                                         return;
2148
2149                                 final String hoverInfo = textHover.getHoverInfo(sourceViewer, hoverRegion);
2150
2151                                 // with information provider
2152                                 IInformationProvider informationProvider = new IInformationProvider() {
2153                                         /*
2154                                          * @see org.eclipse.jface.text.information.IInformationProvider#getSubject(org.eclipse.jface.text.ITextViewer,
2155                                          *      int)
2156                                          */
2157                                         public IRegion getSubject(ITextViewer textViewer, int offset) {
2158                                                 return hoverRegion;
2159                                         }
2160
2161                                         /*
2162                                          * @see org.eclipse.jface.text.information.IInformationProvider#getInformation(org.eclipse.jface.text.ITextViewer,
2163                                          *      org.eclipse.jface.text.IRegion)
2164                                          */
2165                                         public String getInformation(ITextViewer textViewer, IRegion subject) {
2166                                                 return hoverInfo;
2167                                         }
2168                                 };
2169
2170                                 fInformationPresenter.setOffset(offset);
2171                                 fInformationPresenter.setInformationProvider(informationProvider, contentType);
2172                                 fInformationPresenter.showInformation();
2173
2174                         } catch (BadLocationException e) {
2175                         }
2176                 }
2177
2178                 // modified version from TextViewer
2179                 private int computeOffsetAtLocation(ITextViewer textViewer, int x, int y) {
2180
2181                         StyledText styledText = textViewer.getTextWidget();
2182                         IDocument document = textViewer.getDocument();
2183
2184                         if (document == null)
2185                                 return -1;
2186
2187                         try {
2188                                 int widgetLocation = styledText.getOffsetAtLocation(new Point(x, y));
2189                                 if (textViewer instanceof ITextViewerExtension3) {
2190                                         ITextViewerExtension3 extension = (ITextViewerExtension3) textViewer;
2191                                         return extension.widgetOffset2ModelOffset(widgetLocation);
2192                                 } else {
2193                                         IRegion visibleRegion = textViewer.getVisibleRegion();
2194                                         return widgetLocation + visibleRegion.getOffset();
2195                                 }
2196                         } catch (IllegalArgumentException e) {
2197                                 return -1;
2198                         }
2199
2200                 }
2201         };
2202
2203         /**
2204          * This action implements smart home.
2205          *
2206          * Instead of going to the start of a line it does the following: - if smart
2207          * home/end is enabled and the caret is after the line's first non-whitespace
2208          * then the caret is moved directly before it, taking JavaDoc and multi-line
2209          * comments into account. - if the caret is before the line's first
2210          * non-whitespace the caret is moved to the beginning of the line - if the
2211          * caret is at the beginning of the line see first case.
2212          *
2213          * @since 3.0
2214          */
2215         protected class SmartLineStartAction extends LineStartAction {
2216
2217                 /**
2218                  * Creates a new smart line start action
2219                  *
2220                  * @param textWidget
2221                  *          the styled text widget
2222                  * @param doSelect
2223                  *          a boolean flag which tells if the text up to the beginning of
2224                  *          the line should be selected
2225                  */
2226                 public SmartLineStartAction(final StyledText textWidget, final boolean doSelect) {
2227                         super(textWidget, doSelect);
2228                 }
2229
2230                 /*
2231                  * @see org.eclipse.ui.texteditor.AbstractTextEditor.LineStartAction#getLineStartPosition(java.lang.String,
2232                  *      int, java.lang.String)
2233                  */
2234                 protected int getLineStartPosition(final IDocument document, final String line, final int length, final int offset) {
2235
2236                         String type = IDocument.DEFAULT_CONTENT_TYPE;
2237                         try {
2238                                 type = TextUtilities.getContentType(document, IPHPPartitions.PHP_PARTITIONING, offset, true);
2239                         } catch (BadLocationException exception) {
2240                                 // Should not happen
2241                         }
2242
2243                         int index = super.getLineStartPosition(document, line, length, offset);
2244                         if (type.equals(IPHPPartitions.PHP_PHPDOC_COMMENT) || type.equals(IPHPPartitions.PHP_MULTILINE_COMMENT)) {
2245                                 if (index < length - 1 && line.charAt(index) == '*' && line.charAt(index + 1) != '/') {
2246                                         do {
2247                                                 ++index;
2248                                         } while (index < length && Character.isWhitespace(line.charAt(index)));
2249                                 }
2250                         } else {
2251                                 if (index < length - 1 && line.charAt(index) == '/' && line.charAt(index + 1) == '/') {
2252                                         index++;
2253                                         do {
2254                                                 ++index;
2255                                         } while (index < length && Character.isWhitespace(line.charAt(index)));
2256                                 }
2257                         }
2258                         return index;
2259                 }
2260         }
2261
2262         /**
2263          * Text navigation action to navigate to the next sub-word.
2264          *
2265          * @since 3.0
2266          */
2267         protected abstract class NextSubWordAction extends TextNavigationAction {
2268
2269                 protected JavaWordIterator fIterator = new JavaWordIterator();
2270
2271                 /**
2272                  * Creates a new next sub-word action.
2273                  *
2274                  * @param code
2275                  *          Action code for the default operation. Must be an action code
2276                  *          from
2277                  * @see org.eclipse.swt.custom.ST.
2278                  */
2279                 protected NextSubWordAction(int code) {
2280                         super(getSourceViewer().getTextWidget(), code);
2281                 }
2282
2283                 /*
2284                  * @see org.eclipse.jface.action.IAction#run()
2285                  */
2286                 public void run() {
2287                         // Check whether we are in a java code partition and the preference is
2288                         // enabled
2289                         final IPreferenceStore store = getPreferenceStore();
2290                         if (!store.getBoolean(PreferenceConstants.EDITOR_SUB_WORD_NAVIGATION)) {
2291                                 super.run();
2292                                 return;
2293                         }
2294
2295                         final ISourceViewer viewer = getSourceViewer();
2296                         final IDocument document = viewer.getDocument();
2297                         fIterator.setText((CharacterIterator) new DocumentCharacterIterator(document));
2298                         int position = widgetOffset2ModelOffset(viewer, viewer.getTextWidget().getCaretOffset());
2299                         if (position == -1)
2300                                 return;
2301
2302                         int next = findNextPosition(position);
2303                         if (next != BreakIterator.DONE) {
2304                                 setCaretPosition(next);
2305                                 getTextWidget().showSelection();
2306                                 fireSelectionChanged();
2307                         }
2308
2309                 }
2310
2311                 /**
2312                  * Finds the next position after the given position.
2313                  *
2314                  * @param position
2315                  *          the current position
2316                  * @return the next position
2317                  */
2318                 protected int findNextPosition(int position) {
2319                         ISourceViewer viewer = getSourceViewer();
2320                         int widget = -1;
2321                         while (position != BreakIterator.DONE && widget == -1) { // TODO:
2322                                 // optimize
2323                                 position = fIterator.following(position);
2324                                 if (position != BreakIterator.DONE)
2325                                         widget = modelOffset2WidgetOffset(viewer, position);
2326                         }
2327                         return position;
2328                 }
2329
2330                 /**
2331                  * Sets the caret position to the sub-word boundary given with
2332                  * <code>position</code>.
2333                  *
2334                  * @param position
2335                  *          Position where the action should move the caret
2336                  */
2337                 protected abstract void setCaretPosition(int position);
2338         }
2339
2340         /**
2341          * Text navigation action to navigate to the next sub-word.
2342          *
2343          * @since 3.0
2344          */
2345         protected class NavigateNextSubWordAction extends NextSubWordAction {
2346
2347                 /**
2348                  * Creates a new navigate next sub-word action.
2349                  */
2350                 public NavigateNextSubWordAction() {
2351                         super(ST.WORD_NEXT);
2352                 }
2353
2354                 /*
2355                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.NextSubWordAction#setCaretPosition(int)
2356                  */
2357                 protected void setCaretPosition(final int position) {
2358                         getTextWidget().setCaretOffset(modelOffset2WidgetOffset(getSourceViewer(), position));
2359                 }
2360         }
2361
2362         /**
2363          * Text operation action to delete the next sub-word.
2364          *
2365          * @since 3.0
2366          */
2367         protected class DeleteNextSubWordAction extends NextSubWordAction implements IUpdate {
2368
2369                 /**
2370                  * Creates a new delete next sub-word action.
2371                  */
2372                 public DeleteNextSubWordAction() {
2373                         super(ST.DELETE_WORD_NEXT);
2374                 }
2375
2376                 /*
2377                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.NextSubWordAction#setCaretPosition(int)
2378                  */
2379                 protected void setCaretPosition(final int position) {
2380                         if (!validateEditorInputState())
2381                                 return;
2382
2383                         final ISourceViewer viewer = getSourceViewer();
2384                         final int caret = widgetOffset2ModelOffset(viewer, viewer.getTextWidget().getCaretOffset());
2385
2386                         try {
2387                                 viewer.getDocument().replace(caret, position - caret, ""); //$NON-NLS-1$
2388                         } catch (BadLocationException exception) {
2389                                 // Should not happen
2390                         }
2391                 }
2392
2393                 /*
2394                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.NextSubWordAction#findNextPosition(int)
2395                  */
2396                 protected int findNextPosition(int position) {
2397                         return fIterator.following(position);
2398                 }
2399
2400                 /*
2401                  * @see org.eclipse.ui.texteditor.IUpdate#update()
2402                  */
2403                 public void update() {
2404                         setEnabled(isEditorInputModifiable());
2405                 }
2406         }
2407
2408         /**
2409          * Text operation action to select the next sub-word.
2410          *
2411          * @since 3.0
2412          */
2413         protected class SelectNextSubWordAction extends NextSubWordAction {
2414
2415                 /**
2416                  * Creates a new select next sub-word action.
2417                  */
2418                 public SelectNextSubWordAction() {
2419                         super(ST.SELECT_WORD_NEXT);
2420                 }
2421
2422                 /*
2423                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.NextSubWordAction#setCaretPosition(int)
2424                  */
2425                 protected void setCaretPosition(final int position) {
2426                         final ISourceViewer viewer = getSourceViewer();
2427
2428                         final StyledText text = viewer.getTextWidget();
2429                         if (text != null && !text.isDisposed()) {
2430
2431                                 final Point selection = text.getSelection();
2432                                 final int caret = text.getCaretOffset();
2433                                 final int offset = modelOffset2WidgetOffset(viewer, position);
2434
2435                                 if (caret == selection.x)
2436                                         text.setSelectionRange(selection.y, offset - selection.y);
2437                                 else
2438                                         text.setSelectionRange(selection.x, offset - selection.x);
2439                         }
2440                 }
2441         }
2442
2443         /**
2444          * Text navigation action to navigate to the previous sub-word.
2445          *
2446          * @since 3.0
2447          */
2448         protected abstract class PreviousSubWordAction extends TextNavigationAction {
2449
2450                 protected JavaWordIterator fIterator = new JavaWordIterator();
2451
2452                 /**
2453                  * Creates a new previous sub-word action.
2454                  *
2455                  * @param code
2456                  *          Action code for the default operation. Must be an action code
2457                  *          from
2458                  * @see org.eclipse.swt.custom.ST.
2459                  */
2460                 protected PreviousSubWordAction(final int code) {
2461                         super(getSourceViewer().getTextWidget(), code);
2462                 }
2463
2464                 /*
2465                  * @see org.eclipse.jface.action.IAction#run()
2466                  */
2467                 public void run() {
2468                         // Check whether we are in a java code partition and the preference is
2469                         // enabled
2470                         final IPreferenceStore store = getPreferenceStore();
2471                         if (!store.getBoolean(PreferenceConstants.EDITOR_SUB_WORD_NAVIGATION)) {
2472                                 super.run();
2473                                 return;
2474                         }
2475
2476                         final ISourceViewer viewer = getSourceViewer();
2477                         final IDocument document = viewer.getDocument();
2478                         fIterator.setText((CharacterIterator) new DocumentCharacterIterator(document));
2479                         int position = widgetOffset2ModelOffset(viewer, viewer.getTextWidget().getCaretOffset());
2480                         if (position == -1)
2481                                 return;
2482
2483                         int previous = findPreviousPosition(position);
2484                         if (previous != BreakIterator.DONE) {
2485                                 setCaretPosition(previous);
2486                                 getTextWidget().showSelection();
2487                                 fireSelectionChanged();
2488                         }
2489
2490                 }
2491
2492                 /**
2493                  * Finds the previous position before the given position.
2494                  *
2495                  * @param position
2496                  *          the current position
2497                  * @return the previous position
2498                  */
2499                 protected int findPreviousPosition(int position) {
2500                         ISourceViewer viewer = getSourceViewer();
2501                         int widget = -1;
2502                         while (position != BreakIterator.DONE && widget == -1) { // TODO:
2503                                 // optimize
2504                                 position = fIterator.preceding(position);
2505                                 if (position != BreakIterator.DONE)
2506                                         widget = modelOffset2WidgetOffset(viewer, position);
2507                         }
2508                         return position;
2509                 }
2510
2511                 /**
2512                  * Sets the caret position to the sub-word boundary given with
2513                  * <code>position</code>.
2514                  *
2515                  * @param position
2516                  *          Position where the action should move the caret
2517                  */
2518                 protected abstract void setCaretPosition(int position);
2519         }
2520
2521         /**
2522          * Text navigation action to navigate to the previous sub-word.
2523          *
2524          * @since 3.0
2525          */
2526         protected class NavigatePreviousSubWordAction extends PreviousSubWordAction {
2527
2528                 /**
2529                  * Creates a new navigate previous sub-word action.
2530                  */
2531                 public NavigatePreviousSubWordAction() {
2532                         super(ST.WORD_PREVIOUS);
2533                 }
2534
2535                 /*
2536                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.PreviousSubWordAction#setCaretPosition(int)
2537                  */
2538                 protected void setCaretPosition(final int position) {
2539                         getTextWidget().setCaretOffset(modelOffset2WidgetOffset(getSourceViewer(), position));
2540                 }
2541         }
2542
2543         /**
2544          * Text operation action to delete the previous sub-word.
2545          *
2546          * @since 3.0
2547          */
2548         protected class DeletePreviousSubWordAction extends PreviousSubWordAction implements IUpdate {
2549
2550                 /**
2551                  * Creates a new delete previous sub-word action.
2552                  */
2553                 public DeletePreviousSubWordAction() {
2554                         super(ST.DELETE_WORD_PREVIOUS);
2555                 }
2556
2557                 /*
2558                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.PreviousSubWordAction#setCaretPosition(int)
2559                  */
2560                 protected void setCaretPosition(final int position) {
2561                         if (!validateEditorInputState())
2562                                 return;
2563
2564                         final ISourceViewer viewer = getSourceViewer();
2565                         final int caret = widgetOffset2ModelOffset(viewer, viewer.getTextWidget().getCaretOffset());
2566
2567                         try {
2568                                 viewer.getDocument().replace(position, caret - position, ""); //$NON-NLS-1$
2569                         } catch (BadLocationException exception) {
2570                                 // Should not happen
2571                         }
2572                 }
2573
2574                 /*
2575                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.PreviousSubWordAction#findPreviousPosition(int)
2576                  */
2577                 protected int findPreviousPosition(int position) {
2578                         return fIterator.preceding(position);
2579                 }
2580
2581                 /*
2582                  * @see org.eclipse.ui.texteditor.IUpdate#update()
2583                  */
2584                 public void update() {
2585                         setEnabled(isEditorInputModifiable());
2586                 }
2587         }
2588
2589         /**
2590          * Text operation action to select the previous sub-word.
2591          *
2592          * @since 3.0
2593          */
2594         protected class SelectPreviousSubWordAction extends PreviousSubWordAction {
2595
2596                 /**
2597                  * Creates a new select previous sub-word action.
2598                  */
2599                 public SelectPreviousSubWordAction() {
2600                         super(ST.SELECT_WORD_PREVIOUS);
2601                 }
2602
2603                 /*
2604                  * @see net.sourceforge.phpdt.internal.ui.javaeditor.JavaEditor.PreviousSubWordAction#setCaretPosition(int)
2605                  */
2606                 protected void setCaretPosition(final int position) {
2607                         final ISourceViewer viewer = getSourceViewer();
2608
2609                         final StyledText text = viewer.getTextWidget();
2610                         if (text != null && !text.isDisposed()) {
2611
2612                                 final Point selection = text.getSelection();
2613                                 final int caret = text.getCaretOffset();
2614                                 final int offset = modelOffset2WidgetOffset(viewer, position);
2615
2616                                 if (caret == selection.x)
2617                                         text.setSelectionRange(selection.y, offset - selection.y);
2618                                 else
2619                                         text.setSelectionRange(selection.x, offset - selection.x);
2620                         }
2621                 }
2622         }
2623
2624         // static protected class AnnotationAccess implements IAnnotationAccess {
2625         // /*
2626         // * @see
2627         // org.eclipse.jface.text.source.IAnnotationAccess#getType(org.eclipse.jface.text.source.Annotation)
2628         // */
2629         // public Object getType(Annotation annotation) {
2630         // if (annotation instanceof IJavaAnnotation) {
2631         // IJavaAnnotation javaAnnotation = (IJavaAnnotation) annotation;
2632         // // if (javaAnnotation.isRelevant())
2633         // // return javaAnnotation.getAnnotationType();
2634         // }
2635         // return null;
2636         // }
2637         //
2638         // /*
2639         // * @see
2640         // org.eclipse.jface.text.source.IAnnotationAccess#isMultiLine(org.eclipse.jface.text.source.Annotation)
2641         // */
2642         // public boolean isMultiLine(Annotation annotation) {
2643         // return true;
2644         // }
2645         //
2646         // /*
2647         // * @see
2648         // org.eclipse.jface.text.source.IAnnotationAccess#isTemporary(org.eclipse.jface.text.source.Annotation)
2649         // */
2650         // public boolean isTemporary(Annotation annotation) {
2651         // if (annotation instanceof IJavaAnnotation) {
2652         // IJavaAnnotation javaAnnotation = (IJavaAnnotation) annotation;
2653         // if (javaAnnotation.isRelevant())
2654         // return javaAnnotation.isTemporary();
2655         // }
2656         // return false;
2657         // }
2658         // };
2659
2660         private class PropertyChangeListener implements org.eclipse.core.runtime.Preferences.IPropertyChangeListener {
2661                 /*
2662                  * @see IPropertyChangeListener#propertyChange(PropertyChangeEvent)
2663                  */
2664                 public void propertyChange(org.eclipse.core.runtime.Preferences.PropertyChangeEvent event) {
2665                         handlePreferencePropertyChanged(event);
2666                 }
2667         };
2668
2669         /**
2670          * Finds and marks occurrence annotations.
2671          *
2672          * @since 3.0
2673          */
2674         class OccurrencesFinderJob extends Job {
2675
2676                 private IDocument fDocument;
2677
2678                 private ISelection fSelection;
2679
2680                 private ISelectionValidator fPostSelectionValidator;
2681
2682                 private boolean fCanceled = false;
2683
2684                 private IProgressMonitor fProgressMonitor;
2685
2686                 private Position[] fPositions;
2687
2688                 public OccurrencesFinderJob(IDocument document, Position[] positions, ISelection selection) {
2689                         super(PHPEditorMessages.JavaEditor_markOccurrences_job_name);
2690                         fDocument = document;
2691                         fSelection = selection;
2692                         fPositions = positions;
2693
2694                         if (getSelectionProvider() instanceof ISelectionValidator)
2695                                 fPostSelectionValidator = (ISelectionValidator) getSelectionProvider();
2696                 }
2697
2698                 // cannot use cancel() because it is declared final
2699                 void doCancel() {
2700                         fCanceled = true;
2701                         cancel();
2702                 }
2703
2704                 private boolean isCanceled() {
2705                         return fCanceled || fProgressMonitor.isCanceled() || fPostSelectionValidator != null
2706                                         && !(fPostSelectionValidator.isValid(fSelection) || fForcedMarkOccurrencesSelection == fSelection)
2707                                         || LinkedModeModel.hasInstalledModel(fDocument);
2708                 }
2709
2710                 /*
2711                  * @see Job#run(org.eclipse.core.runtime.IProgressMonitor)
2712                  */
2713                 public IStatus run(IProgressMonitor progressMonitor) {
2714
2715                         fProgressMonitor = progressMonitor;
2716
2717                         if (isCanceled())
2718                                 return Status.CANCEL_STATUS;
2719
2720                         ITextViewer textViewer = getViewer();
2721                         if (textViewer == null)
2722                                 return Status.CANCEL_STATUS;
2723
2724                         IDocument document = textViewer.getDocument();
2725                         if (document == null)
2726                                 return Status.CANCEL_STATUS;
2727
2728                         IDocumentProvider documentProvider = getDocumentProvider();
2729                         if (documentProvider == null)
2730                                 return Status.CANCEL_STATUS;
2731
2732                         IAnnotationModel annotationModel = documentProvider.getAnnotationModel(getEditorInput());
2733                         if (annotationModel == null)
2734                                 return Status.CANCEL_STATUS;
2735
2736                         // Add occurrence annotations
2737                         int length = fPositions.length;
2738                         Map annotationMap = new HashMap(length);
2739                         for (int i = 0; i < length; i++) {
2740
2741                                 if (isCanceled())
2742                                         return Status.CANCEL_STATUS;
2743
2744                                 String message;
2745                                 Position position = fPositions[i];
2746
2747                                 // Create & add annotation
2748                                 try {
2749                                         message = document.get(position.offset, position.length);
2750                                 } catch (BadLocationException ex) {
2751                                         // Skip this match
2752                                         continue;
2753                                 }
2754                                 annotationMap.put(new Annotation("net.sourceforge.phpdt.ui.occurrences", false, message), //$NON-NLS-1$
2755                                                 position);
2756                         }
2757
2758                         if (isCanceled())
2759                                 return Status.CANCEL_STATUS;
2760
2761                         synchronized (getLockObject(annotationModel)) {
2762                                 if (annotationModel instanceof IAnnotationModelExtension) {
2763                                         ((IAnnotationModelExtension) annotationModel).replaceAnnotations(fOccurrenceAnnotations, annotationMap);
2764                                 } else {
2765                                         removeOccurrenceAnnotations();
2766                                         Iterator iter = annotationMap.entrySet().iterator();
2767                                         while (iter.hasNext()) {
2768                                                 Map.Entry mapEntry = (Map.Entry) iter.next();
2769                                                 annotationModel.addAnnotation((Annotation) mapEntry.getKey(), (Position) mapEntry.getValue());
2770                                         }
2771                                 }
2772                                 fOccurrenceAnnotations = (Annotation[]) annotationMap.keySet().toArray(new Annotation[annotationMap.keySet().size()]);
2773                         }
2774
2775                         return Status.OK_STATUS;
2776                 }
2777         }
2778
2779         /**
2780          * Cancels the occurrences finder job upon document changes.
2781          *
2782          * @since 3.0
2783          */
2784         class OccurrencesFinderJobCanceler implements IDocumentListener, ITextInputListener {
2785
2786                 public void install() {
2787                         ISourceViewer sourceViewer = getSourceViewer();
2788                         if (sourceViewer == null)
2789                                 return;
2790
2791                         StyledText text = sourceViewer.getTextWidget();
2792                         if (text == null || text.isDisposed())
2793                                 return;
2794
2795                         sourceViewer.addTextInputListener(this);
2796
2797                         IDocument document = sourceViewer.getDocument();
2798                         if (document != null)
2799                                 document.addDocumentListener(this);
2800                 }
2801
2802                 public void uninstall() {
2803                         ISourceViewer sourceViewer = getSourceViewer();
2804                         if (sourceViewer != null)
2805                                 sourceViewer.removeTextInputListener(this);
2806
2807                         IDocumentProvider documentProvider = getDocumentProvider();
2808                         if (documentProvider != null) {
2809                                 IDocument document = documentProvider.getDocument(getEditorInput());
2810                                 if (document != null)
2811                                         document.removeDocumentListener(this);
2812                         }
2813                 }
2814
2815                 /*
2816                  * @see org.eclipse.jface.text.IDocumentListener#documentAboutToBeChanged(org.eclipse.jface.text.DocumentEvent)
2817                  */
2818                 public void documentAboutToBeChanged(DocumentEvent event) {
2819                         if (fOccurrencesFinderJob != null)
2820                                 fOccurrencesFinderJob.doCancel();
2821                 }
2822
2823                 /*
2824                  * @see org.eclipse.jface.text.IDocumentListener#documentChanged(org.eclipse.jface.text.DocumentEvent)
2825                  */
2826                 public void documentChanged(DocumentEvent event) {
2827                 }
2828
2829                 /*
2830                  * @see org.eclipse.jface.text.ITextInputListener#inputDocumentAboutToBeChanged(org.eclipse.jface.text.IDocument,
2831                  *      org.eclipse.jface.text.IDocument)
2832                  */
2833                 public void inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput) {
2834                         if (oldInput == null)
2835                                 return;
2836
2837                         oldInput.removeDocumentListener(this);
2838                 }
2839
2840                 /*
2841                  * @see org.eclipse.jface.text.ITextInputListener#inputDocumentChanged(org.eclipse.jface.text.IDocument,
2842                  *      org.eclipse.jface.text.IDocument)
2843                  */
2844                 public void inputDocumentChanged(IDocument oldInput, IDocument newInput) {
2845                         if (newInput == null)
2846                                 return;
2847                         newInput.addDocumentListener(this);
2848                 }
2849         }
2850
2851         /**
2852          * Internal activation listener.
2853          *
2854          * @since 3.0
2855          */
2856         private class ActivationListener implements IWindowListener {
2857
2858                 /*
2859                  * @see org.eclipse.ui.IWindowListener#windowActivated(org.eclipse.ui.IWorkbenchWindow)
2860                  * @since 3.1
2861                  */
2862                 public void windowActivated(IWorkbenchWindow window) {
2863                         if (window == getEditorSite().getWorkbenchWindow() && fMarkOccurrenceAnnotations && isActivePart()) {
2864                                 fForcedMarkOccurrencesSelection = getSelectionProvider().getSelection();
2865                                 SelectionListenerWithASTManager.getDefault().forceSelectionChange(PHPEditor.this,
2866                                                 (ITextSelection) fForcedMarkOccurrencesSelection);
2867                         }
2868                 }
2869
2870                 /*
2871                  * @see org.eclipse.ui.IWindowListener#windowDeactivated(org.eclipse.ui.IWorkbenchWindow)
2872                  * @since 3.1
2873                  */
2874                 public void windowDeactivated(IWorkbenchWindow window) {
2875                         if (window == getEditorSite().getWorkbenchWindow() && fMarkOccurrenceAnnotations && isActivePart())
2876                                 removeOccurrenceAnnotations();
2877                 }
2878
2879                 /*
2880                  * @see org.eclipse.ui.IWindowListener#windowClosed(org.eclipse.ui.IWorkbenchWindow)
2881                  * @since 3.1
2882                  */
2883                 public void windowClosed(IWorkbenchWindow window) {
2884                 }
2885
2886                 /*
2887                  * @see org.eclipse.ui.IWindowListener#windowOpened(org.eclipse.ui.IWorkbenchWindow)
2888                  * @since 3.1
2889                  */
2890                 public void windowOpened(IWorkbenchWindow window) {
2891                 }
2892         }
2893
2894         /**
2895          * Updates the selection in the editor's widget with the selection of the
2896          * outline page.
2897          */
2898         class OutlineSelectionChangedListener extends AbstractSelectionChangedListener {
2899                 public void selectionChanged(SelectionChangedEvent event) {
2900                         doSelectionChanged(event);
2901                 }
2902         }
2903
2904         /**
2905          * The internal shell activation listener for updating occurrences.
2906          *
2907          * @since 3.0
2908          */
2909         private ActivationListener fActivationListener = new ActivationListener();
2910
2911         private ISelectionListenerWithAST fPostSelectionListenerWithAST;
2912
2913         private OccurrencesFinderJob fOccurrencesFinderJob;
2914
2915         /** The occurrences finder job canceler */
2916         private OccurrencesFinderJobCanceler fOccurrencesFinderJobCanceler;
2917
2918         /**
2919          * Holds the current occurrence annotations.
2920          *
2921          * @since 3.0
2922          */
2923         private Annotation[] fOccurrenceAnnotations = null;
2924
2925         /**
2926          * Tells whether all occurrences of the element at the current caret location
2927          * are automatically marked in this editor.
2928          *
2929          * @since 3.0
2930          */
2931         private boolean fMarkOccurrenceAnnotations;
2932
2933         /**
2934          * The selection used when forcing occurrence marking through code.
2935          *
2936          * @since 3.0
2937          */
2938         private ISelection fForcedMarkOccurrencesSelection;
2939
2940         /**
2941          * The document modification stamp at the time when the last occurrence
2942          * marking took place.
2943          *
2944          * @since 3.1
2945          */
2946         private long fMarkOccurrenceModificationStamp = IDocumentExtension4.UNKNOWN_MODIFICATION_STAMP;
2947
2948         /**
2949          * The region of the word under the caret used to when computing the current
2950          * occurrence markings.
2951          *
2952          * @since 3.1
2953          */
2954         private IRegion fMarkOccurrenceTargetRegion;
2955
2956         /**
2957          * Tells whether the occurrence annotations are sticky i.e. whether they stay
2958          * even if there's no valid Java element at the current caret position. Only
2959          * valid if {@link #fMarkOccurrenceAnnotations} is <code>true</code>.
2960          *
2961          * @since 3.0
2962          */
2963         private boolean fStickyOccurrenceAnnotations;
2964
2965         /** Preference key for showing the line number ruler */
2966         // private final static String LINE_NUMBER_RULER =
2967         // PreferenceConstants.EDITOR_LINE_NUMBER_RULER;
2968         /** Preference key for the foreground color of the line numbers */
2969         // private final static String LINE_NUMBER_COLOR =
2970         // PreferenceConstants.EDITOR_LINE_NUMBER_RULER_COLOR;
2971         /** Preference key for the link color */
2972         private final static String LINK_COLOR = PreferenceConstants.EDITOR_LINK_COLOR;
2973
2974         /** Preference key for compiler task tags */
2975         private final static String COMPILER_TASK_TAGS = JavaCore.COMPILER_TASK_TAGS;
2976
2977         // protected PHPActionGroup fActionGroups;
2978         // /** The outline page */
2979         // private AbstractContentOutlinePage fOutlinePage;
2980         /** The outline page */
2981         protected JavaOutlinePage fOutlinePage;
2982
2983         /** Outliner context menu Id */
2984         protected String fOutlinerContextMenuId;
2985
2986         /**
2987          * Indicates whether this editor should react on outline page selection
2988          * changes
2989          */
2990         private int fIgnoreOutlinePageSelection;
2991
2992         /** The outline page selection updater */
2993         // private OutlinePageSelectionUpdater fUpdater;
2994         // protected PHPSyntaxParserThread fValidationThread = null;
2995         // private IPreferenceStore fPHPPrefStore;
2996         /** The selection changed listener */
2997         // protected ISelectionChangedListener fSelectionChangedListener = new
2998         // SelectionChangedListener();
2999         /**
3000          * The editor selection changed listener.
3001          *
3002          * @since 3.0
3003          */
3004         private EditorSelectionChangedListener fEditorSelectionChangedListener;
3005
3006         /** The selection changed listener */
3007         protected AbstractSelectionChangedListener fOutlineSelectionChangedListener = new OutlineSelectionChangedListener();
3008
3009         /** The editor's bracket matcher */
3010         private PHPPairMatcher fBracketMatcher = new PHPPairMatcher(BRACKETS);
3011
3012         /** The line number ruler column */
3013         // private LineNumberRulerColumn fLineNumberRulerColumn;
3014         /** This editor's encoding support */
3015         private DefaultEncodingSupport fEncodingSupport;
3016
3017         /** The mouse listener */
3018         private MouseClickListener fMouseListener;
3019
3020         /**
3021          * Indicates whether this editor is about to update any annotation views.
3022          *
3023          * @since 3.0
3024          */
3025         private boolean fIsUpdatingAnnotationViews = false;
3026
3027         /**
3028          * The marker that served as last target for a goto marker request.
3029          *
3030          * @since 3.0
3031          */
3032         private IMarker fLastMarkerTarget = null;
3033
3034         protected CompositeActionGroup fActionGroups;
3035
3036         protected CompositeActionGroup fContextMenuGroup;
3037
3038         /**
3039          * This editor's projection support
3040          *
3041          * @since 3.0
3042          */
3043         private ProjectionSupport fProjectionSupport;
3044
3045         /**
3046          * This editor's projection model updater
3047          *
3048          * @since 3.0
3049          */
3050         private IJavaFoldingStructureProvider fProjectionModelUpdater;
3051
3052         /**
3053          * The override and implements indicator manager for this editor.
3054          *
3055          * @since 3.0
3056          */
3057         // protected OverrideIndicatorManager fOverrideIndicatorManager;
3058         /**
3059          * The action group for folding.
3060          *
3061          * @since 3.0
3062          */
3063         private FoldingActionGroup fFoldingGroup;
3064
3065         /** The information presenter. */
3066         private InformationPresenter fInformationPresenter;
3067
3068         /** The annotation access */
3069         // protected IAnnotationAccess fAnnotationAccess = new AnnotationAccess();
3070         /** The overview ruler */
3071         protected OverviewRuler isOverviewRulerVisible;
3072
3073         /** The source viewer decoration support */
3074         // protected SourceViewerDecorationSupport fSourceViewerDecorationSupport;
3075         /** The overview ruler */
3076         // protected OverviewRuler fOverviewRuler;
3077         /** The preference property change listener for java core. */
3078         private org.eclipse.core.runtime.Preferences.IPropertyChangeListener fPropertyChangeListener = new PropertyChangeListener();
3079
3080         /**
3081          * Returns the most narrow java element including the given offset
3082          *
3083          * @param offset
3084          *          the offset inside of the requested element
3085          */
3086         abstract protected IJavaElement getElementAt(int offset);
3087
3088         /**
3089          * Returns the java element of this editor's input corresponding to the given
3090          * IJavaElement
3091          */
3092         abstract protected IJavaElement getCorrespondingElement(IJavaElement element);
3093
3094         /**
3095          * Sets the input of the editor's outline page.
3096          */
3097         abstract protected void setOutlinePageInput(JavaOutlinePage page, IEditorInput input);
3098
3099         /**
3100          * Default constructor.
3101          */
3102         public PHPEditor() {
3103                 super();
3104         }
3105
3106         /*
3107          * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#initializeKeyBindingScopes()
3108          */
3109         protected void initializeKeyBindingScopes() {
3110                 setKeyBindingScopes(new String[] { "net.sourceforge.phpdt.ui.phpEditorScope" }); //$NON-NLS-1$
3111         }
3112
3113         /*
3114          * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#initializeEditor()
3115          */
3116         protected void initializeEditor() {
3117                 // jsurfer old code
3118                 // JavaTextTools textTools =
3119                 // PHPeclipsePlugin.getDefault().getJavaTextTools();
3120                 // setSourceViewerConfiguration(new PHPSourceViewerConfiguration(textTools,
3121                 // this, IPHPPartitions.PHP_PARTITIONING)); //,
3122                 // IJavaPartitions.JAVA_PARTITIONING));
3123                 IPreferenceStore store = createCombinedPreferenceStore(null);
3124                 setPreferenceStore(store);
3125                 JavaTextTools textTools = PHPeclipsePlugin.getDefault().getJavaTextTools();
3126                 setSourceViewerConfiguration(new PHPSourceViewerConfiguration(textTools.getColorManager(), store, this,
3127                                 IPHPPartitions.PHP_PARTITIONING));
3128
3129                 // TODO changed in 3.x ?
3130                 // setRangeIndicator(new DefaultRangeIndicator());
3131                 // if
3132                 // (PreferenceConstants.getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_SYNC_OUTLINE_ON_CURSOR_MOVE))
3133                 // fUpdater = new OutlinePageSelectionUpdater();
3134                 // jsurfer end
3135
3136                 // IPreferenceStore store= createCombinedPreferenceStore(null);
3137                 // setPreferenceStore(store);
3138                 // JavaTextTools textTools=
3139                 // PHPeclipsePlugin.getDefault().getJavaTextTools();
3140                 // setSourceViewerConfiguration(new
3141                 // JavaSourceViewerConfiguration(textTools.getColorManager(), store,
3142                 // this, IJavaPartitions.JAVA_PARTITIONING));
3143                 fMarkOccurrenceAnnotations = store.getBoolean(PreferenceConstants.EDITOR_MARK_OCCURRENCES);
3144                 fStickyOccurrenceAnnotations = store.getBoolean(PreferenceConstants.EDITOR_STICKY_OCCURRENCES);
3145                 // fMarkTypeOccurrences=
3146                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_TYPE_OCCURRENCES);
3147                 // fMarkMethodOccurrences=
3148                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_METHOD_OCCURRENCES);
3149                 // fMarkConstantOccurrences=
3150                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_CONSTANT_OCCURRENCES);
3151                 // fMarkFieldOccurrences=
3152                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_FIELD_OCCURRENCES);
3153                 // fMarkLocalVariableypeOccurrences=
3154                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_LOCAL_VARIABLE_OCCURRENCES);
3155                 // fMarkExceptions=
3156                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_EXCEPTION_OCCURRENCES);
3157                 // fMarkImplementors=
3158                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_IMPLEMENTORS);
3159                 // fMarkMethodExitPoints=
3160                 // store.getBoolean(PreferenceConstants.EDITOR_MARK_METHOD_EXIT_POINTS);
3161
3162         }
3163
3164         /*
3165          * @see org.eclipse.ui.texteditor.AbstractTextEditor#updatePropertyDependentActions()
3166          */
3167         protected void updatePropertyDependentActions() {
3168                 super.updatePropertyDependentActions();
3169                 if (fEncodingSupport != null)
3170                         fEncodingSupport.reset();
3171         }
3172
3173         /*
3174          * Update the hovering behavior depending on the preferences.
3175          */
3176         private void updateHoverBehavior() {
3177                 SourceViewerConfiguration configuration = getSourceViewerConfiguration();
3178                 String[] types = configuration.getConfiguredContentTypes(getSourceViewer());
3179
3180                 for (int i = 0; i < types.length; i++) {
3181
3182                         String t = types[i];
3183
3184                         int[] stateMasks = configuration.getConfiguredTextHoverStateMasks(getSourceViewer(), t);
3185
3186                         ISourceViewer sourceViewer = getSourceViewer();
3187                         if (sourceViewer instanceof ITextViewerExtension2) {
3188                                 if (stateMasks != null) {
3189                                         for (int j = 0; j < stateMasks.length; j++) {
3190                                                 int stateMask = stateMasks[j];
3191                                                 ITextHover textHover = configuration.getTextHover(sourceViewer, t, stateMask);
3192                                                 ((ITextViewerExtension2) sourceViewer).setTextHover(textHover, t, stateMask);
3193                                         }
3194                                 } else {
3195                                         ITextHover textHover = configuration.getTextHover(sourceViewer, t);
3196                                         ((ITextViewerExtension2) sourceViewer).setTextHover(textHover, t, ITextViewerExtension2.DEFAULT_HOVER_STATE_MASK);
3197                                 }
3198                         } else
3199                                 sourceViewer.setTextHover(configuration.getTextHover(sourceViewer, t), t);
3200                 }
3201         }
3202
3203         public void updatedTitleImage(Image image) {
3204                 setTitleImage(image);
3205         }
3206
3207         /*
3208          * @see net.sourceforge.phpdt.internal.ui.viewsupport.IViewPartInputProvider#getViewPartInput()
3209          */
3210         public Object getViewPartInput() {
3211                 return getEditorInput().getAdapter(IResource.class);
3212         }
3213
3214         /*
3215          * @see org.eclipse.ui.texteditor.AbstractTextEditor#doSetSelection(ISelection)
3216          */
3217         protected void doSetSelection(ISelection selection) {
3218                 super.doSetSelection(selection);
3219                 synchronizeOutlinePageSelection();
3220         }
3221
3222         boolean isFoldingEnabled() {
3223                 return PHPeclipsePlugin.getDefault().getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_FOLDING_ENABLED);
3224         }
3225
3226         /*
3227          * @see org.eclipse.ui.IWorkbenchPart#createPartControl(org.eclipse.swt.
3228          *      widgets.Composite)
3229          */
3230         public void createPartControl(Composite parent) {
3231                 super.createPartControl(parent);
3232
3233                 // fSourceViewerDecorationSupport.install(getPreferenceStore());
3234
3235                 ProjectionViewer projectionViewer = (ProjectionViewer) getSourceViewer();
3236
3237                 fProjectionSupport = new ProjectionSupport(projectionViewer, getAnnotationAccess(), getSharedColors());
3238                 fProjectionSupport.addSummarizableAnnotationType("org.eclipse.ui.workbench.texteditor.error"); //$NON-NLS-1$
3239                 fProjectionSupport.addSummarizableAnnotationType("org.eclipse.ui.workbench.texteditor.warning"); //$NON-NLS-1$
3240                 fProjectionSupport.setHoverControlCreator(new IInformationControlCreator() {
3241                         public IInformationControl createInformationControl(Shell shell) {
3242                                 return new CustomSourceInformationControl(shell, IDocument.DEFAULT_CONTENT_TYPE);
3243                         }
3244                 });
3245                 fProjectionSupport.install();
3246
3247                 fProjectionModelUpdater = PHPeclipsePlugin.getDefault().getFoldingStructureProviderRegistry().getCurrentFoldingProvider();
3248                 if (fProjectionModelUpdater != null)
3249                         fProjectionModelUpdater.install(this, projectionViewer);
3250
3251                 if (isFoldingEnabled())
3252                         projectionViewer.doOperation(ProjectionViewer.TOGGLE);
3253                 Preferences preferences = PHPeclipsePlugin.getDefault().getPluginPreferences();
3254                 preferences.addPropertyChangeListener(fPropertyChangeListener);
3255
3256                 IInformationControlCreator informationControlCreator = new IInformationControlCreator() {
3257                         public IInformationControl createInformationControl(Shell parent) {
3258                                 boolean cutDown = false;
3259                                 int style = cutDown ? SWT.NONE : (SWT.V_SCROLL | SWT.H_SCROLL);
3260                                 return new DefaultInformationControl(parent, SWT.RESIZE, style, new HTMLTextPresenter(cutDown));
3261                         }
3262                 };
3263
3264                 fInformationPresenter = new InformationPresenter(informationControlCreator);
3265                 fInformationPresenter.setSizeConstraints(60, 10, true, true);
3266                 fInformationPresenter.install(getSourceViewer());
3267
3268                 fEditorSelectionChangedListener = new EditorSelectionChangedListener();
3269                 fEditorSelectionChangedListener.install(getSelectionProvider());
3270
3271                 if (isBrowserLikeLinks())
3272                         enableBrowserLikeLinks();
3273
3274                 if (PreferenceConstants.getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_DISABLE_OVERWRITE_MODE))
3275                         enableOverwriteMode(false);
3276
3277                 if (fMarkOccurrenceAnnotations)
3278                         installOccurrencesFinder();
3279
3280                 PlatformUI.getWorkbench().addWindowListener(fActivationListener);
3281
3282                 setWordWrap();
3283         }
3284
3285         private void setWordWrap() {
3286                 if (getSourceViewer() != null) {
3287                         getSourceViewer().getTextWidget().setWordWrap(
3288                                         PHPeclipsePlugin.getDefault().getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_WRAP_WORDS));
3289                 }
3290         }
3291
3292         protected void configureSourceViewerDecorationSupport(SourceViewerDecorationSupport support) {
3293
3294                 support.setCharacterPairMatcher(fBracketMatcher);
3295                 support.setMatchingCharacterPainterPreferenceKeys(MATCHING_BRACKETS, MATCHING_BRACKETS_COLOR);
3296
3297                 super.configureSourceViewerDecorationSupport(support);
3298         }
3299
3300         /*
3301          * @see org.eclipse.ui.texteditor.AbstractTextEditor#gotoMarker(org.eclipse.core.resources.IMarker)
3302          */
3303         public void gotoMarker(IMarker marker) {
3304                 fLastMarkerTarget = marker;
3305                 if (!fIsUpdatingAnnotationViews) {
3306                         super.gotoMarker(marker);
3307                 }
3308         }
3309
3310         /**
3311          * Jumps to the next enabled annotation according to the given direction. An
3312          * annotation type is enabled if it is configured to be in the Next/Previous
3313          * tool bar drop down menu and if it is checked.
3314          *
3315          * @param forward
3316          *          <code>true</code> if search direction is forward,
3317          *          <code>false</code> if backward
3318          */
3319         public void gotoAnnotation(boolean forward) {
3320                 ITextSelection selection = (ITextSelection) getSelectionProvider().getSelection();
3321                 Position position = new Position(0, 0);
3322                 if (false /* delayed - see bug 18316 */) {
3323                         getNextAnnotation(selection.getOffset(), selection.getLength(), forward, position);
3324                         selectAndReveal(position.getOffset(), position.getLength());
3325                 } else /* no delay - see bug 18316 */{
3326                         Annotation annotation = getNextAnnotation(selection.getOffset(), selection.getLength(), forward, position);
3327                         setStatusLineErrorMessage(null);
3328                         setStatusLineMessage(null);
3329                         if (annotation != null) {
3330                                 updateAnnotationViews(annotation);
3331                                 selectAndReveal(position.getOffset(), position.getLength());
3332                                 setStatusLineMessage(annotation.getText());
3333                         }
3334                 }
3335         }
3336
3337         /**
3338          * Returns the lock object for the given annotation model.
3339          *
3340          * @param annotationModel
3341          *          the annotation model
3342          * @return the annotation model's lock object
3343          * @since 3.0
3344          */
3345         private Object getLockObject(IAnnotationModel annotationModel) {
3346                 if (annotationModel instanceof ISynchronizable)
3347                         return ((ISynchronizable) annotationModel).getLockObject();
3348                 else
3349                         return annotationModel;
3350         }
3351
3352         /**
3353          * Updates the annotation views that show the given annotation.
3354          *
3355          * @param annotation
3356          *          the annotation
3357          */
3358         private void updateAnnotationViews(Annotation annotation) {
3359                 IMarker marker = null;
3360                 if (annotation instanceof MarkerAnnotation)
3361                         marker = ((MarkerAnnotation) annotation).getMarker();
3362                 else if (annotation instanceof IJavaAnnotation) {
3363                         Iterator e = ((IJavaAnnotation) annotation).getOverlaidIterator();
3364                         if (e != null) {
3365                                 while (e.hasNext()) {
3366                                         Object o = e.next();
3367                                         if (o instanceof MarkerAnnotation) {
3368                                                 marker = ((MarkerAnnotation) o).getMarker();
3369                                                 break;
3370                                         }
3371                                 }
3372                         }
3373                 }
3374
3375                 if (marker != null && !marker.equals(fLastMarkerTarget)) {
3376                         try {
3377                                 boolean isProblem = marker.isSubtypeOf(IMarker.PROBLEM);
3378                                 IWorkbenchPage page = getSite().getPage();
3379                                 IViewPart view = page.findView(isProblem ? IPageLayout.ID_PROBLEM_VIEW : IPageLayout.ID_TASK_LIST); //$NON-NLS-1$  //$NON-NLS-2$
3380                                 if (view != null) {
3381                                         Method method = view.getClass().getMethod("setSelection", new Class[] { IStructuredSelection.class, boolean.class }); //$NON-NLS-1$
3382                                         method.invoke(view, new Object[] { new StructuredSelection(marker), Boolean.TRUE });
3383                                 }
3384                         } catch (CoreException x) {
3385                         } catch (NoSuchMethodException x) {
3386                         } catch (IllegalAccessException x) {
3387                         } catch (InvocationTargetException x) {
3388                         }
3389                         // ignore exceptions, don't update any of the lists, just set status line
3390                 }
3391         }
3392
3393         /**
3394          * Returns this document's complete text.
3395          *
3396          * @return the document's complete text
3397          */
3398         public String get() {
3399                 IDocument doc = this.getDocumentProvider().getDocument(this.getEditorInput());
3400                 return doc.get();
3401         }
3402
3403         /**
3404          * Sets the outliner's context menu ID.
3405          */
3406         protected void setOutlinerContextMenuId(String menuId) {
3407                 fOutlinerContextMenuId = menuId;
3408         }
3409
3410         /**
3411          * Returns the standard action group of this editor.
3412          */
3413         protected ActionGroup getActionGroup() {
3414                 return fActionGroups;
3415         }
3416
3417         // public JavaOutlinePage getfOutlinePage() {
3418         // return fOutlinePage;
3419         // }
3420
3421         /**
3422          * The <code>PHPEditor</code> implementation of this
3423          * <code>AbstractTextEditor</code> method extend the actions to add those
3424          * specific to the receiver
3425          */
3426         protected void createActions() {
3427                 super.createActions();
3428
3429                 ActionGroup oeg, ovg, jsg, sg;
3430                 fActionGroups = new CompositeActionGroup(new ActionGroup[] { oeg = new OpenEditorActionGroup(this),
3431                 // sg= new ShowActionGroup(this),
3432                                 // ovg= new OpenViewActionGroup(this),
3433                                 // jsg= new JavaSearchActionGroup(this)
3434                                 });
3435                 fContextMenuGroup = new CompositeActionGroup(new ActionGroup[] { oeg });
3436                 // , ovg, sg, jsg});
3437
3438                 fFoldingGroup = new FoldingActionGroup(this, getViewer());
3439
3440                 // ResourceAction resAction = new
3441                 // TextOperationAction(PHPEditorMessages.getResourceBundle(),
3442                 // "ShowJavaDoc.", this, ISourceViewer.INFORMATION, true); //$NON-NLS-1$
3443                 // resAction = new
3444                 // InformationDispatchAction(PHPEditorMessages.getResourceBundle(),
3445                 // "ShowJavaDoc.", (TextOperationAction) resAction); //$NON-NLS-1$
3446                 // resAction.setActionDefinitionId(net.sourceforge.phpdt.ui.actions.PHPEditorActionDefinitionIds.SHOW_JAVADOC);
3447                 // setAction("ShowJavaDoc", resAction); //$NON-NLS-1$
3448
3449                 // WorkbenchHelp.setHelp(resAction,
3450                 // IJavaHelpContextIds.SHOW_JAVADOC_ACTION);
3451
3452                 Action action = new GotoMatchingBracketAction(this);
3453                 action.setActionDefinitionId(PHPEditorActionDefinitionIds.GOTO_MATCHING_BRACKET);
3454                 setAction(GotoMatchingBracketAction.GOTO_MATCHING_BRACKET, action);
3455
3456                 // action= new
3457                 // TextOperationAction(PHPEditorMessages.getResourceBundle(),"ShowOutline.",
3458                 // this, JavaSourceViewer.SHOW_OUTLINE, true); //$NON-NLS-1$
3459                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SHOW_OUTLINE);
3460                 // setAction(PHPEditorActionDefinitionIds.SHOW_OUTLINE, action);
3461                 // // WorkbenchHelp.setHelp(action,
3462                 // IJavaHelpContextIds.SHOW_OUTLINE_ACTION);
3463                 //
3464                 // action= new
3465                 // TextOperationAction(PHPEditorMessages.getResourceBundle(),"OpenStructure.",
3466                 // this, JavaSourceViewer.OPEN_STRUCTURE, true); //$NON-NLS-1$
3467                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SHOW_OUTLINE.OPEN_STRUCTURE);
3468                 // setAction(PHPEditorActionDefinitionIds.SHOW_OUTLINE.OPEN_STRUCTURE,
3469                 // action);
3470                 // // WorkbenchHelp.setHelp(action,
3471                 // IJavaHelpContextIds.OPEN_STRUCTURE_ACTION);
3472                 //
3473                 // action= new
3474                 // TextOperationAction(PHPEditorMessages.getResourceBundle(),"OpenHierarchy.",
3475                 // this, JavaSourceViewer.SHOW_HIERARCHY, true); //$NON-NLS-1$
3476                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SHOW_OUTLINE.OPEN_HIERARCHY);
3477                 // setAction(PHPEditorActionDefinitionIds.SHOW_OUTLINE.OPEN_HIERARCHY,
3478                 // action);
3479                 // // WorkbenchHelp.setHelp(action,
3480                 // IJavaHelpContextIds.OPEN_HIERARCHY_ACTION);
3481
3482                 fEncodingSupport = new DefaultEncodingSupport();
3483                 fEncodingSupport.initialize(this);
3484
3485                 // fSelectionHistory= new SelectionHistory(this);
3486                 //
3487                 // action= new StructureSelectEnclosingAction(this, fSelectionHistory);
3488                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SELECT_ENCLOSING);
3489                 // setAction(StructureSelectionAction.ENCLOSING, action);
3490                 //
3491                 // action= new StructureSelectNextAction(this, fSelectionHistory);
3492                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SELECT_NEXT);
3493                 // setAction(StructureSelectionAction.NEXT, action);
3494                 //
3495                 // action= new StructureSelectPreviousAction(this, fSelectionHistory);
3496                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.SELECT_PREVIOUS);
3497                 // setAction(StructureSelectionAction.PREVIOUS, action);
3498                 //
3499                 // StructureSelectHistoryAction historyAction= new
3500                 // StructureSelectHistoryAction(this, fSelectionHistory);
3501                 // historyAction.setActionDefinitionId(PHPEditorActionDefinitionIds.SELECT_LAST);
3502                 // setAction(StructureSelectionAction.HISTORY, historyAction);
3503                 // fSelectionHistory.setHistoryAction(historyAction);
3504                 //
3505                 // action= GoToNextPreviousMemberAction.newGoToNextMemberAction(this);
3506                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.GOTO_NEXT_MEMBER);
3507                 // setAction(GoToNextPreviousMemberAction.NEXT_MEMBER, action);
3508                 //
3509                 // action=
3510                 // GoToNextPreviousMemberAction.newGoToPreviousMemberAction(this);
3511                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.GOTO_PREVIOUS_MEMBER);
3512                 // setAction(GoToNextPreviousMemberAction.PREVIOUS_MEMBER, action);
3513                 //
3514                 // action= new QuickFormatAction();
3515                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.QUICK_FORMAT);
3516                 // setAction(IJavaEditorActionDefinitionIds.QUICK_FORMAT, action);
3517                 //
3518                 // action= new RemoveOccurrenceAnnotations(this);
3519                 // action.setActionDefinitionId(PHPEditorActionDefinitionIds.REMOVE_OCCURRENCE_ANNOTATIONS);
3520                 // setAction("RemoveOccurrenceAnnotations", action); //$NON-NLS-1$
3521
3522                 // add annotation actions
3523                 action = new JavaSelectMarkerRulerAction2(PHPEditorMessages.getResourceBundle(), "Editor.RulerAnnotationSelection.", this); //$NON-NLS-1$
3524                 setAction("AnnotationAction", action); //$NON-NLS-1$
3525         }
3526
3527         private void internalDoSetInput(IEditorInput input) throws CoreException {
3528                 super.doSetInput(input);
3529
3530                 if (getSourceViewer() instanceof JavaSourceViewer) {
3531                         JavaSourceViewer viewer = (JavaSourceViewer) getSourceViewer();
3532                         if (viewer.getReconciler() == null) {
3533                                 IReconciler reconciler = getSourceViewerConfiguration().getReconciler(viewer);
3534                                 if (reconciler != null) {
3535                                         reconciler.install(viewer);
3536                                         viewer.setReconciler(reconciler);
3537                                 }
3538                         }
3539                 }
3540
3541                 if (fEncodingSupport != null)
3542                         fEncodingSupport.reset();
3543
3544                 setOutlinePageInput(fOutlinePage, input);
3545
3546                 if (fProjectionModelUpdater != null)
3547                         fProjectionModelUpdater.initialize();
3548
3549                 // if (isShowingOverrideIndicators())
3550                 // installOverrideIndicator(false);
3551         }
3552
3553         /*
3554          * @see org.eclipse.ui.texteditor.AbstractTextEditor#setPreferenceStore(org.eclipse.jface.preference.IPreferenceStore)
3555          * @since 3.0
3556          */
3557         protected void setPreferenceStore(IPreferenceStore store) {
3558                 super.setPreferenceStore(store);
3559                 if (getSourceViewerConfiguration() instanceof PHPSourceViewerConfiguration) {
3560                         JavaTextTools textTools = PHPeclipsePlugin.getDefault().getJavaTextTools();
3561                         setSourceViewerConfiguration(new PHPSourceViewerConfiguration(textTools.getColorManager(), store, this,
3562                                         IPHPPartitions.PHP_PARTITIONING));
3563                 }
3564                 if (getSourceViewer() instanceof JavaSourceViewer)
3565                         ((JavaSourceViewer) getSourceViewer()).setPreferenceStore(store);
3566         }
3567
3568         /**
3569          * The <code>PHPEditor</code> implementation of this
3570          * <code>AbstractTextEditor</code> method performs any extra disposal
3571          * actions required by the php editor.
3572          */
3573         public void dispose() {
3574                 if (fProjectionModelUpdater != null) {
3575                         fProjectionModelUpdater.uninstall();
3576                         fProjectionModelUpdater = null;
3577                 }
3578
3579                 if (fProjectionSupport != null) {
3580                         fProjectionSupport.dispose();
3581                         fProjectionSupport = null;
3582                 }
3583                 // PHPEditorEnvironment.disconnect(this);
3584                 if (fOutlinePage != null)
3585                         fOutlinePage.setInput(null);
3586
3587                 if (fActionGroups != null)
3588                         fActionGroups.dispose();
3589
3590                 if (isBrowserLikeLinks())
3591                         disableBrowserLikeLinks();
3592
3593                 // cancel possible running computation
3594                 fMarkOccurrenceAnnotations = false;
3595                 uninstallOccurrencesFinder();
3596
3597                 uninstallOverrideIndicator();
3598
3599                 if (fActivationListener != null) {
3600                         PlatformUI.getWorkbench().removeWindowListener(fActivationListener);
3601                         fActivationListener = null;
3602                 }
3603
3604                 if (fEncodingSupport != null) {
3605                         fEncodingSupport.dispose();
3606                         fEncodingSupport = null;
3607                 }
3608
3609                 if (fPropertyChangeListener != null) {
3610                         Preferences preferences = PHPeclipsePlugin.getDefault().getPluginPreferences();
3611                         preferences.removePropertyChangeListener(fPropertyChangeListener);
3612                         fPropertyChangeListener = null;
3613                 }
3614
3615                 // if (fSourceViewerDecorationSupport != null) {
3616                 // fSourceViewerDecorationSupport.dispose();
3617                 // fSourceViewerDecorationSupport = null;
3618                 // }
3619
3620                 if (fBracketMatcher != null) {
3621                         fBracketMatcher.dispose();
3622                         fBracketMatcher = null;
3623                 }
3624
3625                 if (fEditorSelectionChangedListener != null) {
3626                         fEditorSelectionChangedListener.uninstall(getSelectionProvider());
3627                         fEditorSelectionChangedListener = null;
3628                 }
3629
3630                 super.dispose();
3631         }
3632
3633         /**
3634          * The <code>PHPEditor</code> implementation of this
3635          * <code>AbstractTextEditor</code> method performs any extra revert behavior
3636          * required by the php editor.
3637          */
3638         // public void doRevertToSaved() {
3639         // super.doRevertToSaved();
3640         // if (fOutlinePage != null)
3641         // fOutlinePage.update();
3642         // }
3643         /**
3644          * The <code>PHPEditor</code> implementation of this
3645          * <code>AbstractTextEditor</code> method performs any extra save behavior
3646          * required by the php editor.
3647          */
3648         // public void doSave(IProgressMonitor monitor) {
3649         // super.doSave(monitor);
3650         // compile or not, according to the user preferences
3651         // IPreferenceStore store = getPreferenceStore();
3652         // the parse on save was changed to the eclipse "builders" concept
3653         // if (store.getBoolean(PHPeclipsePlugin.PHP_PARSE_ON_SAVE)) {
3654         // IAction a = PHPParserAction.getInstance();
3655         // if (a != null)
3656         // a.run();
3657         // }
3658         // if (SWT.getPlatform().equals("win32")) {
3659         // IAction a = ShowExternalPreviewAction.getInstance();
3660         // if (a != null)
3661         // a.run();
3662         // }
3663         // if (fOutlinePage != null)
3664         // fOutlinePage.update();
3665         // }
3666         /**
3667          * The <code>PHPEditor</code> implementation of this
3668          * <code>AbstractTextEditor</code> method performs any extra save as
3669          * behavior required by the php editor.
3670          */
3671         // public void doSaveAs() {
3672         // super.doSaveAs();
3673         // if (fOutlinePage != null)
3674         // fOutlinePage.update();
3675         // }
3676         /*
3677          * @see StatusTextEditor#getStatusHeader(IStatus)
3678          */
3679         protected String getStatusHeader(IStatus status) {
3680                 if (fEncodingSupport != null) {
3681                         String message = fEncodingSupport.getStatusHeader(status);
3682                         if (message != null)
3683                                 return message;
3684                 }
3685                 return super.getStatusHeader(status);
3686         }
3687
3688         /*
3689          * @see StatusTextEditor#getStatusBanner(IStatus)
3690          */
3691         protected String getStatusBanner(IStatus status) {
3692                 if (fEncodingSupport != null) {
3693                         String message = fEncodingSupport.getStatusBanner(status);
3694                         if (message != null)
3695                                 return message;
3696                 }
3697                 return super.getStatusBanner(status);
3698         }
3699
3700         /*
3701          * @see StatusTextEditor#getStatusMessage(IStatus)
3702          */
3703         protected String getStatusMessage(IStatus status) {
3704                 if (fEncodingSupport != null) {
3705                         String message = fEncodingSupport.getStatusMessage(status);
3706                         if (message != null)
3707                                 return message;
3708                 }
3709                 return super.getStatusMessage(status);
3710         }
3711
3712         /**
3713          * The <code>PHPEditor</code> implementation of this
3714          * <code>AbstractTextEditor</code> method performs sets the input of the
3715          * outline page after AbstractTextEditor has set input.
3716          */
3717         // protected void doSetInput(IEditorInput input) throws CoreException {
3718         // super.doSetInput(input);
3719         // if (fEncodingSupport != null)
3720         // fEncodingSupport.reset();
3721         // setOutlinePageInput(fOutlinePage, input);
3722         // }
3723         /*
3724          * @see AbstractTextEditor#doSetInput
3725          */
3726         protected void doSetInput(IEditorInput input) throws CoreException {
3727                 ISourceViewer sourceViewer = getSourceViewer();
3728                 if (!(sourceViewer instanceof ISourceViewerExtension2)) {
3729                         setPreferenceStore(createCombinedPreferenceStore(input));
3730                         internalDoSetInput(input);
3731                         return;
3732                 }
3733
3734                 // uninstall & unregister preference store listener
3735                 if (isBrowserLikeLinks())
3736                         disableBrowserLikeLinks();
3737                 getSourceViewerDecorationSupport(sourceViewer).uninstall();
3738                 ((ISourceViewerExtension2) sourceViewer).unconfigure();
3739
3740                 setPreferenceStore(createCombinedPreferenceStore(input));
3741
3742                 // install & register preference store listener
3743                 sourceViewer.configure(getSourceViewerConfiguration());
3744                 getSourceViewerDecorationSupport(sourceViewer).install(getPreferenceStore());
3745                 if (isBrowserLikeLinks())
3746                         enableBrowserLikeLinks();
3747
3748                 internalDoSetInput(input);
3749         }
3750
3751         /*
3752          * @see org.phpeclipse.phpdt.internal.ui.viewsupport.IViewPartInputProvider#getViewPartInput()
3753          */
3754         // public Object getViewPartInput() {
3755         // return getEditorInput().getAdapter(IFile.class);
3756         // }
3757         /**
3758          * The <code>PHPEditor</code> implementation of this
3759          * <code>AbstractTextEditor</code> method adds any PHPEditor specific
3760          * entries.
3761          */
3762         public void editorContextMenuAboutToShow(MenuManager menu) {
3763                 super.editorContextMenuAboutToShow(menu);
3764                 menu.appendToGroup(ITextEditorActionConstants.GROUP_UNDO, new Separator(IContextMenuConstants.GROUP_OPEN));
3765                 menu.insertAfter(IContextMenuConstants.GROUP_OPEN, new GroupMarker(IContextMenuConstants.GROUP_SHOW));
3766
3767                 ActionContext context = new ActionContext(getSelectionProvider().getSelection());
3768                 fContextMenuGroup.setContext(context);
3769                 fContextMenuGroup.fillContextMenu(menu);
3770                 fContextMenuGroup.setContext(null);
3771                 // addAction(menu, ITextEditorActionConstants.GROUP_EDIT, "Format");
3772                 // //$NON-NLS-1$
3773                 //
3774                 // ActionContext context =
3775                 // new ActionContext(getSelectionProvider().getSelection());
3776                 // fContextMenuGroup.setContext(context);
3777                 // fContextMenuGroup.fillContextMenu(menu);
3778                 // fContextMenuGroup.setContext(null);
3779         }
3780
3781         /**
3782          * Creates the outline page used with this editor.
3783          */
3784         protected JavaOutlinePage createOutlinePage() {
3785                 JavaOutlinePage page = new JavaOutlinePage(fOutlinerContextMenuId, this);
3786                 fOutlineSelectionChangedListener.install(page);
3787                 setOutlinePageInput(page, getEditorInput());
3788                 return page;
3789         }
3790
3791         /**
3792          * Informs the editor that its outliner has been closed.
3793          */
3794         public void outlinePageClosed() {
3795                 if (fOutlinePage != null) {
3796                         fOutlineSelectionChangedListener.uninstall(fOutlinePage);
3797                         fOutlinePage = null;
3798                         resetHighlightRange();
3799                 }
3800         }
3801
3802         /**
3803          * Synchronizes the outliner selection with the given element position in the
3804          * editor.
3805          *
3806          * @param element
3807          *          the java element to select
3808          */
3809         protected void synchronizeOutlinePage(ISourceReference element) {
3810                 synchronizeOutlinePage(element, true);
3811         }
3812
3813         /**
3814          * Synchronizes the outliner selection with the given element position in the
3815          * editor.
3816          *
3817          * @param element
3818          *          the java element to select
3819          * @param checkIfOutlinePageActive
3820          *          <code>true</code> if check for active outline page needs to be
3821          *          done
3822          */
3823         protected void synchronizeOutlinePage(ISourceReference element, boolean checkIfOutlinePageActive) {
3824                 if (fOutlinePage != null && element != null && !(checkIfOutlinePageActive && isJavaOutlinePageActive())) {
3825                         fOutlineSelectionChangedListener.uninstall(fOutlinePage);
3826                         fOutlinePage.select(element);
3827                         fOutlineSelectionChangedListener.install(fOutlinePage);
3828                 }
3829         }
3830
3831         /**
3832          * Synchronizes the outliner selection with the actual cursor position in the
3833          * editor.
3834          */
3835         public void synchronizeOutlinePageSelection() {
3836                 synchronizeOutlinePage(computeHighlightRangeSourceReference());
3837
3838                 // ISourceViewer sourceViewer = getSourceViewer();
3839                 // if (sourceViewer == null || fOutlinePage == null)
3840                 // return;
3841                 //
3842                 // StyledText styledText = sourceViewer.getTextWidget();
3843                 // if (styledText == null)
3844                 // return;
3845                 //
3846                 // int caret = 0;
3847                 // if (sourceViewer instanceof ITextViewerExtension3) {
3848                 // ITextViewerExtension3 extension = (ITextViewerExtension3)
3849                 // sourceViewer;
3850                 // caret =
3851                 // extension.widgetOffset2ModelOffset(styledText.getCaretOffset());
3852                 // } else {
3853                 // int offset = sourceViewer.getVisibleRegion().getOffset();
3854                 // caret = offset + styledText.getCaretOffset();
3855                 // }
3856                 //
3857                 // IJavaElement element = getElementAt(caret);
3858                 // if (element instanceof ISourceReference) {
3859                 // fOutlinePage.removeSelectionChangedListener(fSelectionChangedListener);
3860                 // fOutlinePage.select((ISourceReference) element);
3861                 // fOutlinePage.addSelectionChangedListener(fSelectionChangedListener);
3862                 // }
3863         }
3864
3865         protected void setSelection(ISourceReference reference, boolean moveCursor) {
3866
3867                 ISelection selection = getSelectionProvider().getSelection();
3868                 if (selection instanceof TextSelection) {
3869                         TextSelection textSelection = (TextSelection) selection;
3870                         if (textSelection.getOffset() != 0 || textSelection.getLength() != 0)
3871                                 markInNavigationHistory();
3872                 }
3873
3874                 if (reference != null) {
3875
3876                         StyledText textWidget = null;
3877
3878                         ISourceViewer sourceViewer = getSourceViewer();
3879                         if (sourceViewer != null)
3880                                 textWidget = sourceViewer.getTextWidget();
3881
3882                         if (textWidget == null)
3883                                 return;
3884
3885                         try {
3886
3887                                 ISourceRange range = reference.getSourceRange();
3888                                 if (range == null)
3889                                         return;
3890
3891                                 int offset = range.getOffset();
3892                                 int length = range.getLength();
3893
3894                                 if (offset < 0 || length < 0)
3895                                         return;
3896
3897                                 textWidget.setRedraw(false);
3898
3899                                 setHighlightRange(offset, length, moveCursor);
3900
3901                                 if (!moveCursor)
3902                                         return;
3903
3904                                 offset = -1;
3905                                 length = -1;
3906
3907                                 if (reference instanceof IMember) {
3908                                         range = ((IMember) reference).getNameRange();
3909                                         if (range != null) {
3910                                                 offset = range.getOffset();
3911                                                 length = range.getLength();
3912                                         }
3913                                 }
3914                                 // else if (reference instanceof IImportDeclaration) {
3915                                 // String name= ((IImportDeclaration)
3916                                 // reference).getElementName();
3917                                 // if (name != null && name.length() > 0) {
3918                                 // String content= reference.getSource();
3919                                 // if (content != null) {
3920                                 // offset= range.getOffset() + content.indexOf(name);
3921                                 // length= name.length();
3922                                 // }
3923                                 // }
3924                                 // } else if (reference instanceof IPackageDeclaration) {
3925                                 // String name= ((IPackageDeclaration)
3926                                 // reference).getElementName();
3927                                 // if (name != null && name.length() > 0) {
3928                                 // String content= reference.getSource();
3929                                 // if (content != null) {
3930                                 // offset= range.getOffset() + content.indexOf(name);
3931                                 // length= name.length();
3932                                 // }
3933                                 // }
3934                                 // }
3935
3936                                 if (offset > -1 && length > 0) {
3937                                         sourceViewer.revealRange(offset, length);
3938                                         sourceViewer.setSelectedRange(offset, length);
3939                                 }
3940
3941                         } catch (JavaModelException x) {
3942                         } catch (IllegalArgumentException x) {
3943                         } finally {
3944                                 if (textWidget != null)
3945                                         textWidget.setRedraw(true);
3946                         }
3947
3948                 } else if (moveCursor) {
3949                         resetHighlightRange();
3950                 }
3951
3952                 markInNavigationHistory();
3953         }
3954
3955         public void setSelection(IJavaElement element) {
3956                 if (element == null || element instanceof ICompilationUnit) { // ||
3957                         // element
3958                         // instanceof
3959                         // IClassFile)
3960                         // {
3961                         /*
3962                          * If the element is an ICompilationUnit this unit is either the input of
3963                          * this editor or not being displayed. In both cases, nothing should
3964                          * happened. (http://dev.eclipse.org/bugs/show_bug.cgi?id=5128)
3965                          */
3966                         return;
3967                 }
3968
3969                 IJavaElement corresponding = getCorrespondingElement(element);
3970                 if (corresponding instanceof ISourceReference) {
3971                         ISourceReference reference = (ISourceReference) corresponding;
3972                         // set highlight range
3973                         setSelection(reference, true);
3974                         // set outliner selection
3975                         if (fOutlinePage != null) {
3976                                 fOutlineSelectionChangedListener.uninstall(fOutlinePage);
3977                                 fOutlinePage.select(reference);
3978                                 fOutlineSelectionChangedListener.install(fOutlinePage);
3979                         }
3980                 }
3981         }
3982
3983         public synchronized void editingScriptStarted() {
3984                 ++fIgnoreOutlinePageSelection;
3985         }
3986
3987         public synchronized void editingScriptEnded() {
3988                 --fIgnoreOutlinePageSelection;
3989         }
3990
3991         public synchronized boolean isEditingScriptRunning() {
3992                 return (fIgnoreOutlinePageSelection > 0);
3993         }
3994
3995         /**
3996          * The <code>PHPEditor</code> implementation of this
3997          * <code>AbstractTextEditor</code> method performs gets the java content
3998          * outline page if request is for a an outline page.
3999          */
4000         public Object getAdapter(Class required) {
4001
4002                 if (IContentOutlinePage.class.equals(required)) {
4003                         if (fOutlinePage == null)
4004                                 fOutlinePage = createOutlinePage();
4005                         return fOutlinePage;
4006                 }
4007
4008                 if (IEncodingSupport.class.equals(required))
4009                         return fEncodingSupport;
4010
4011                 if (required == IShowInTargetList.class) {
4012                         return new IShowInTargetList() {
4013                                 public String[] getShowInTargetIds() {
4014                                         return new String[] { JavaUI.ID_PACKAGES, IPageLayout.ID_OUTLINE, IPageLayout.ID_RES_NAV };
4015                                 }
4016
4017                         };
4018                 }
4019                 if (fProjectionSupport != null) {
4020                         Object adapter = fProjectionSupport.getAdapter(getSourceViewer(), required);
4021                         if (adapter != null)
4022                                 return adapter;
4023                 }
4024
4025                 return super.getAdapter(required);
4026         }
4027
4028         // public Object getAdapter(Class required) {
4029         // if (IContentOutlinePage.class.equals(required)) {
4030         // if (fOutlinePage == null) {
4031         // fOutlinePage = new PHPContentOutlinePage(getDocumentProvider(), this);
4032         // if (getEditorInput() != null)
4033         // fOutlinePage.setInput(getEditorInput());
4034         // }
4035         // return fOutlinePage;
4036         // }
4037         //
4038         // if (IEncodingSupport.class.equals(required))
4039         // return fEncodingSupport;
4040         //
4041         // return super.getAdapter(required);
4042         // }
4043
4044         protected void doSelectionChanged(SelectionChangedEvent event) {
4045                 ISourceReference reference = null;
4046
4047                 ISelection selection = event.getSelection();
4048                 Iterator iter = ((IStructuredSelection) selection).iterator();
4049                 while (iter.hasNext()) {
4050                         Object o = iter.next();
4051                         if (o instanceof ISourceReference) {
4052                                 reference = (ISourceReference) o;
4053                                 break;
4054                         }
4055                 }
4056
4057                 if (!isActivePart() && PHPeclipsePlugin.getActivePage() != null)
4058                         PHPeclipsePlugin.getActivePage().bringToTop(this);
4059
4060                 try {
4061                         editingScriptStarted();
4062                         setSelection(reference, !isActivePart());
4063                 } finally {
4064                         editingScriptEnded();
4065                 }
4066         }
4067
4068         /*
4069          * @see AbstractTextEditor#adjustHighlightRange(int, int)
4070          */
4071         protected void adjustHighlightRange(int offset, int length) {
4072
4073                 try {
4074
4075                         IJavaElement element = getElementAt(offset);
4076                         while (element instanceof ISourceReference) {
4077                                 ISourceRange range = ((ISourceReference) element).getSourceRange();
4078                                 if (offset < range.getOffset() + range.getLength() && range.getOffset() < offset + length) {
4079
4080                                         ISourceViewer viewer = getSourceViewer();
4081                                         if (viewer instanceof ITextViewerExtension5) {
4082                                                 ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
4083                                                 extension.exposeModelRange(new Region(range.getOffset(), range.getLength()));
4084                                         }
4085
4086                                         setHighlightRange(range.getOffset(), range.getLength(), true);
4087                                         if (fOutlinePage != null) {
4088                                                 fOutlineSelectionChangedListener.uninstall(fOutlinePage);
4089                                                 fOutlinePage.select((ISourceReference) element);
4090                                                 fOutlineSelectionChangedListener.install(fOutlinePage);
4091                                         }
4092
4093                                         return;
4094                                 }
4095                                 element = element.getParent();
4096                         }
4097
4098                 } catch (JavaModelException x) {
4099                         PHPeclipsePlugin.log(x.getStatus());
4100                 }
4101
4102                 ISourceViewer viewer = getSourceViewer();
4103                 if (viewer instanceof ITextViewerExtension5) {
4104                         ITextViewerExtension5 extension = (ITextViewerExtension5) viewer;
4105                         extension.exposeModelRange(new Region(offset, length));
4106                 } else {
4107                         resetHighlightRange();
4108                 }
4109
4110         }
4111
4112         protected boolean isActivePart() {
4113                 IWorkbenchWindow window = getSite().getWorkbenchWindow();
4114                 IPartService service = window.getPartService();
4115                 IWorkbenchPart part = service.getActivePart();
4116                 return part != null && part.equals(this);
4117         }
4118
4119         // public void openContextHelp() {
4120         // IDocument doc =
4121         // this.getDocumentProvider().getDocument(this.getEditorInput());
4122         // ITextSelection selection = (ITextSelection)
4123         // this.getSelectionProvider().getSelection();
4124         // int pos = selection.getOffset();
4125         // String word = getFunctionName(doc, pos);
4126         // openContextHelp(word);
4127         // }
4128         //
4129         // private void openContextHelp(String word) {
4130         // open(word);
4131         // }
4132         //
4133         // public static void open(String word) {
4134         // IHelp help = WorkbenchHelp.getHelpSupport();
4135         // if (help != null) {
4136         // IHelpResource helpResource = new PHPFunctionHelpResource(word);
4137         // WorkbenchHelp.getHelpSupport().displayHelpResource(helpResource);
4138         // } else {
4139         // // showMessage(shell, dialogTitle, ActionMessages.getString("Open help
4140         // not available"), false); //$NON-NLS-1$
4141         // }
4142         // }
4143
4144         // private String getFunctionName(IDocument doc, int pos) {
4145         // Point word = PHPWordExtractor.findWord(doc, pos);
4146         // if (word != null) {
4147         // try {
4148         // return doc.get(word.x, word.y).replace('_', '-');
4149         // } catch (BadLocationException e) {
4150         // }
4151         // }
4152         // return "";
4153         // }
4154
4155         /*
4156          * @see AbstractTextEditor#handlePreferenceStoreChanged(PropertyChangeEvent)
4157          */
4158         protected void handlePreferenceStoreChanged(PropertyChangeEvent event) {
4159
4160                 try {
4161
4162                         ISourceViewer sourceViewer = getSourceViewer();
4163                         if (sourceViewer == null)
4164                                 return;
4165
4166                         String property = event.getProperty();
4167
4168                         if (PreferenceConstants.EDITOR_TAB_WIDTH.equals(property)) {
4169                                 Object value = event.getNewValue();
4170                                 if (value instanceof Integer) {
4171                                         sourceViewer.getTextWidget().setTabs(((Integer) value).intValue());
4172                                 } else if (value instanceof String) {
4173                                         try {
4174                                                 sourceViewer.getTextWidget().setTabs(Integer.parseInt((String) value));
4175                                         } catch (NumberFormatException e) {
4176                                                 // bug #1038071 - set default tab:
4177                                                 sourceViewer.getTextWidget().setTabs(80);
4178                                         }
4179                                 }
4180                                 return;
4181                         }
4182
4183                         // if (OVERVIEW_RULER.equals(property)) {
4184                         // if (isOverviewRulerVisible())
4185                         // showOverviewRuler();
4186                         // else
4187                         // hideOverviewRuler();
4188                         // return;
4189                         // }
4190
4191                         // if (LINE_NUMBER_RULER.equals(property)) {
4192                         // if (isLineNumberRulerVisible())
4193                         // showLineNumberRuler();
4194                         // else
4195                         // hideLineNumberRuler();
4196                         // return;
4197                         // }
4198
4199                         // if (fLineNumberRulerColumn != null
4200                         // && (LINE_NUMBER_COLOR.equals(property) ||
4201                         // PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT.equals(property) ||
4202                         // PREFERENCE_COLOR_BACKGROUND.equals(property))) {
4203                         //
4204                         // initializeLineNumberRulerColumn(fLineNumberRulerColumn);
4205                         // }
4206
4207                         if (isJavaEditorHoverProperty(property))
4208                                 updateHoverBehavior();
4209
4210                         if (BROWSER_LIKE_LINKS.equals(property)) {
4211                                 if (isBrowserLikeLinks())
4212                                         enableBrowserLikeLinks();
4213                                 else
4214                                         disableBrowserLikeLinks();
4215                                 return;
4216                         }
4217
4218                         if (PreferenceConstants.EDITOR_DISABLE_OVERWRITE_MODE.equals(property)) {
4219                                 if (event.getNewValue() instanceof Boolean) {
4220                                         Boolean disable = (Boolean) event.getNewValue();
4221                                         enableOverwriteMode(!disable.booleanValue());
4222                                 }
4223                                 return;
4224                         }
4225
4226                         boolean newBooleanValue = false;
4227                         Object newValue = event.getNewValue();
4228                         if (newValue != null)
4229                                 newBooleanValue = Boolean.valueOf(newValue.toString()).booleanValue();
4230
4231                         if (PreferenceConstants.EDITOR_SYNC_OUTLINE_ON_CURSOR_MOVE.equals(property)) {
4232                                 if (newBooleanValue)
4233                                         selectionChanged();
4234                                 return;
4235                         }
4236
4237                         if (PreferenceConstants.EDITOR_MARK_OCCURRENCES.equals(property)) {
4238                                 if (newBooleanValue != fMarkOccurrenceAnnotations) {
4239                                         fMarkOccurrenceAnnotations = newBooleanValue;
4240                                         if (!fMarkOccurrenceAnnotations)
4241                                                 uninstallOccurrencesFinder();
4242                                         else
4243                                                 installOccurrencesFinder();
4244                                 }
4245                                 return;
4246                         }
4247
4248                         if (PreferenceConstants.EDITOR_STICKY_OCCURRENCES.equals(property)) {
4249                                 fStickyOccurrenceAnnotations = newBooleanValue;
4250                                 return;
4251                         }
4252                         // }
4253                         // }
4254                         // if
4255                         // (PreferenceConstants.EDITOR_STICKY_OCCURRENCES.equals(property))
4256                         // {
4257                         // if (event.getNewValue() instanceof Boolean) {
4258                         // boolean stickyOccurrenceAnnotations=
4259                         // ((Boolean)event.getNewValue()).booleanValue();
4260                         // if (stickyOccurrenceAnnotations != fStickyOccurrenceAnnotations)
4261                         // {
4262
4263                         ((PHPSourceViewerConfiguration) getSourceViewerConfiguration()).handlePropertyChangeEvent(event);
4264
4265                         // if (affectsOverrideIndicatorAnnotations(event)) {
4266                         // if (isShowingOverrideIndicators()) {
4267                         // if (fOverrideIndicatorManager == null)
4268                         // installOverrideIndicator(true);
4269                         // } else {
4270                         // if (fOverrideIndicatorManager != null)
4271                         // uninstallOverrideIndicator();
4272                         // }
4273                         // return;
4274                         // }
4275
4276                         if (PreferenceConstants.EDITOR_FOLDING_PROVIDER.equals(property)) {
4277                                 if (sourceViewer instanceof ProjectionViewer) {
4278                                         ProjectionViewer projectionViewer = (ProjectionViewer) sourceViewer;
4279                                         if (fProjectionModelUpdater != null)
4280                                                 fProjectionModelUpdater.uninstall();
4281                                         // either freshly enabled or provider changed
4282                                         fProjectionModelUpdater = PHPeclipsePlugin.getDefault().getFoldingStructureProviderRegistry().getCurrentFoldingProvider();
4283                                         if (fProjectionModelUpdater != null) {
4284                                                 fProjectionModelUpdater.install(this, projectionViewer);
4285                                         }
4286                                 }
4287                                 return;
4288                         }
4289                 } finally {
4290                         super.handlePreferenceStoreChanged(event);
4291                 }
4292         }
4293
4294         // /*
4295         // * @see
4296         // AbstractTextEditor#handlePreferenceStoreChanged(PropertyChangeEvent)
4297         // */
4298         // protected void handlePreferenceStoreChanged(PropertyChangeEvent event) {
4299         //
4300         // try {
4301         //
4302         // ISourceViewer sourceViewer = getSourceViewer();
4303         // if (sourceViewer == null)
4304         // return;
4305         //
4306         // String property = event.getProperty();
4307         //
4308         // // if
4309         // (JavaSourceViewerConfiguration.PREFERENCE_TAB_WIDTH.equals(property)) {
4310         // // Object value= event.getNewValue();
4311         // // if (value instanceof Integer) {
4312         // // sourceViewer.getTextWidget().setTabs(((Integer) value).intValue());
4313         // // } else if (value instanceof String) {
4314         // // sourceViewer.getTextWidget().setTabs(Integer.parseInt((String)
4315         // value));
4316         // // }
4317         // // return;
4318         // // }
4319         //
4320         // if (IPreferenceConstants.LINE_NUMBER_RULER.equals(property)) {
4321         // if (isLineNumberRulerVisible())
4322         // showLineNumberRuler();
4323         // else
4324         // hideLineNumberRuler();
4325         // return;
4326         // }
4327         //
4328         // if (fLineNumberRulerColumn != null
4329         // && (IPreferenceConstants.LINE_NUMBER_COLOR.equals(property)
4330         // || PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT.equals(property)
4331         // || PREFERENCE_COLOR_BACKGROUND.equals(property))) {
4332         //
4333         // initializeLineNumberRulerColumn(fLineNumberRulerColumn);
4334         // }
4335         //
4336         // } finally {
4337         // super.handlePreferenceStoreChanged(event);
4338         // }
4339         // }
4340
4341         // private boolean isJavaEditorHoverProperty(String property) {
4342         // return PreferenceConstants.EDITOR_DEFAULT_HOVER.equals(property)
4343         // || PreferenceConstants.EDITOR_NONE_HOVER.equals(property)
4344         // || PreferenceConstants.EDITOR_CTRL_HOVER.equals(property)
4345         // || PreferenceConstants.EDITOR_SHIFT_HOVER.equals(property)
4346         // || PreferenceConstants.EDITOR_CTRL_ALT_HOVER.equals(property)
4347         // || PreferenceConstants.EDITOR_CTRL_SHIFT_HOVER.equals(property)
4348         // || PreferenceConstants.EDITOR_CTRL_ALT_SHIFT_HOVER.equals(property)
4349         // || PreferenceConstants.EDITOR_ALT_SHIFT_HOVER.equals(property);
4350         // }
4351
4352         /**
4353          * Shows the line number ruler column.
4354          */
4355         // private void showLineNumberRuler() {
4356         // IVerticalRuler v = getVerticalRuler();
4357         // if (v instanceof CompositeRuler) {
4358         // CompositeRuler c = (CompositeRuler) v;
4359         // c.addDecorator(1, createLineNumberRulerColumn());
4360         // }
4361         // }
4362         private boolean isJavaEditorHoverProperty(String property) {
4363                 return PreferenceConstants.EDITOR_TEXT_HOVER_MODIFIERS.equals(property);
4364         }
4365
4366         /**
4367          * Return whether the browser like links should be enabled according to the
4368          * preference store settings.
4369          *
4370          * @return <code>true</code> if the browser like links should be enabled
4371          */
4372         private boolean isBrowserLikeLinks() {
4373                 IPreferenceStore store = getPreferenceStore();
4374                 return store.getBoolean(BROWSER_LIKE_LINKS);
4375         }
4376
4377         /**
4378          * Enables browser like links.
4379          */
4380         private void enableBrowserLikeLinks() {
4381                 if (fMouseListener == null) {
4382                         fMouseListener = new MouseClickListener();
4383                         fMouseListener.install();
4384                 }
4385         }
4386
4387         /**
4388          * Disables browser like links.
4389          */
4390         private void disableBrowserLikeLinks() {
4391                 if (fMouseListener != null) {
4392                         fMouseListener.uninstall();
4393                         fMouseListener = null;
4394                 }
4395         }
4396
4397         /**
4398          * Handles a property change event describing a change of the java core's
4399          * preferences and updates the preference related editor properties.
4400          *
4401          * @param event
4402          *          the property change event
4403          */
4404         protected void handlePreferencePropertyChanged(org.eclipse.core.runtime.Preferences.PropertyChangeEvent event) {
4405                 if (COMPILER_TASK_TAGS.equals(event.getProperty())) {
4406                         ISourceViewer sourceViewer = getSourceViewer();
4407                         if (sourceViewer != null
4408                                         && affectsTextPresentation(new PropertyChangeEvent(event.getSource(), event.getProperty(), event.getOldValue(), event
4409                                                         .getNewValue())))
4410                                 sourceViewer.invalidateTextPresentation();
4411                 }
4412                 if (PreferenceConstants.EDITOR_WRAP_WORDS.equals(event.getProperty())) {
4413                         setWordWrap();
4414                 }
4415         }
4416
4417         /**
4418          * Return whether the line number ruler column should be visible according to
4419          * the preference store settings.
4420          *
4421          * @return <code>true</code> if the line numbers should be visible
4422          */
4423         // protected boolean isLineNumberRulerVisible() {
4424         // IPreferenceStore store = getPreferenceStore();
4425         // return store.getBoolean(LINE_NUMBER_RULER);
4426         // }
4427         /**
4428          * Hides the line number ruler column.
4429          */
4430         // private void hideLineNumberRuler() {
4431         // IVerticalRuler v = getVerticalRuler();
4432         // if (v instanceof CompositeRuler) {
4433         // CompositeRuler c = (CompositeRuler) v;
4434         // try {
4435         // c.removeDecorator(1);
4436         // } catch (Throwable e) {
4437         // }
4438         // }
4439         // }
4440         /*
4441          * @see AbstractTextEditor#handleCursorPositionChanged()
4442          */
4443         // protected void handleCursorPositionChanged() {
4444         // super.handleCursorPositionChanged();
4445         // if (!isEditingScriptRunning() && fUpdater != null)
4446         // fUpdater.post();
4447         // }
4448         /*
4449          * @see org.eclipse.ui.texteditor.AbstractTextEditor#handleElementContentReplaced()
4450          */
4451         protected void handleElementContentReplaced() {
4452                 super.handleElementContentReplaced();
4453                 if (fProjectionModelUpdater != null)
4454                         fProjectionModelUpdater.initialize();
4455         }
4456
4457         /**
4458          * Initializes the given line number ruler column from the preference store.
4459          *
4460          * @param rulerColumn
4461          *          the ruler column to be initialized
4462          */
4463         // protected void initializeLineNumberRulerColumn(LineNumberRulerColumn
4464         // rulerColumn) {
4465         // JavaTextTools textTools =
4466         // PHPeclipsePlugin.getDefault().getJavaTextTools();
4467         // IColorManager manager = textTools.getColorManager();
4468         //
4469         // IPreferenceStore store = getPreferenceStore();
4470         // if (store != null) {
4471         //
4472         // RGB rgb = null;
4473         // // foreground color
4474         // if (store.contains(LINE_NUMBER_COLOR)) {
4475         // if (store.isDefault(LINE_NUMBER_COLOR))
4476         // rgb = PreferenceConverter.getDefaultColor(store, LINE_NUMBER_COLOR);
4477         // else
4478         // rgb = PreferenceConverter.getColor(store, LINE_NUMBER_COLOR);
4479         // }
4480         // rulerColumn.setForeground(manager.getColor(rgb));
4481         //
4482         // rgb = null;
4483         // // background color
4484         // if (!store.getBoolean(PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT)) {
4485         // if (store.contains(PREFERENCE_COLOR_BACKGROUND)) {
4486         // if (store.isDefault(PREFERENCE_COLOR_BACKGROUND))
4487         // rgb = PreferenceConverter.getDefaultColor(store,
4488         // PREFERENCE_COLOR_BACKGROUND);
4489         // else
4490         // rgb = PreferenceConverter.getColor(store, PREFERENCE_COLOR_BACKGROUND);
4491         // }
4492         // }
4493         // rulerColumn.setBackground(manager.getColor(rgb));
4494         // }
4495         // }
4496         /**
4497          * Creates a new line number ruler column that is appropriately initialized.
4498          */
4499         // protected IVerticalRulerColumn createLineNumberRulerColumn() {
4500         // fLineNumberRulerColumn = new LineNumberRulerColumn();
4501         // initializeLineNumberRulerColumn(fLineNumberRulerColumn);
4502         // return fLineNumberRulerColumn;
4503         // }
4504         /*
4505          * @see AbstractTextEditor#createVerticalRuler()
4506          */
4507         // protected IVerticalRuler createVerticalRuler() {
4508         // CompositeRuler ruler = new CompositeRuler();
4509         // ruler.addDecorator(0, new AnnotationRulerColumn(VERTICAL_RULER_WIDTH));
4510         // if (isLineNumberRulerVisible())
4511         // ruler.addDecorator(1, createLineNumberRulerColumn());
4512         // return ruler;
4513         // }
4514         // private static IRegion getSignedSelection(ITextViewer viewer) {
4515         //
4516         // StyledText text = viewer.getTextWidget();
4517         // int caretOffset = text.getCaretOffset();
4518         // Point selection = text.getSelection();
4519         //
4520         // // caret left
4521         // int offset, length;
4522         // if (caretOffset == selection.x) {
4523         // offset = selection.y;
4524         // length = selection.x - selection.y;
4525         //
4526         // // caret right
4527         // } else {
4528         // offset = selection.x;
4529         // length = selection.y - selection.x;
4530         // }
4531         //
4532         // return new Region(offset, length);
4533         // }
4534         protected IRegion getSignedSelection(ISourceViewer sourceViewer) {
4535                 StyledText text = sourceViewer.getTextWidget();
4536                 Point selection = text.getSelectionRange();
4537
4538                 if (text.getCaretOffset() == selection.x) {
4539                         selection.x = selection.x + selection.y;
4540                         selection.y = -selection.y;
4541                 }
4542
4543                 selection.x = widgetOffset2ModelOffset(sourceViewer, selection.x);
4544
4545                 return new Region(selection.x, selection.y);
4546         }
4547
4548         /** Preference key for matching brackets */
4549         protected final static String MATCHING_BRACKETS = PreferenceConstants.EDITOR_MATCHING_BRACKETS;
4550
4551         /** Preference key for matching brackets color */
4552         protected final static String MATCHING_BRACKETS_COLOR = PreferenceConstants.EDITOR_MATCHING_BRACKETS_COLOR;
4553
4554         /** Preference key for highlighting current line */
4555         // protected final static String CURRENT_LINE =
4556         // PreferenceConstants.EDITOR_CURRENT_LINE;
4557         /** Preference key for highlight color of current line */
4558         // protected final static String CURRENT_LINE_COLOR =
4559         // PreferenceConstants.EDITOR_CURRENT_LINE_COLOR;
4560         /** Preference key for showing print marging ruler */
4561         // protected final static String PRINT_MARGIN =
4562         // PreferenceConstants.EDITOR_PRINT_MARGIN;
4563         /** Preference key for print margin ruler color */
4564         // protected final static String PRINT_MARGIN_COLOR =
4565         // PreferenceConstants.EDITOR_PRINT_MARGIN_COLOR;
4566         /** Preference key for print margin ruler column */
4567         // protected final static String PRINT_MARGIN_COLUMN =
4568         // PreferenceConstants.EDITOR_PRINT_MARGIN_COLUMN;
4569         /** Preference key for error indication */
4570         // protected final static String ERROR_INDICATION =
4571         // PreferenceConstants.EDITOR_PROBLEM_INDICATION;
4572         /** Preference key for error color */
4573         // protected final static String ERROR_INDICATION_COLOR =
4574         // PreferenceConstants.EDITOR_PROBLEM_INDICATION_COLOR;
4575         /** Preference key for warning indication */
4576         // protected final static String WARNING_INDICATION =
4577         // PreferenceConstants.EDITOR_WARNING_INDICATION;
4578         /** Preference key for warning color */
4579         // protected final static String WARNING_INDICATION_COLOR =
4580         // PreferenceConstants.EDITOR_WARNING_INDICATION_COLOR;
4581         /** Preference key for task indication */
4582         protected final static String TASK_INDICATION = PreferenceConstants.EDITOR_TASK_INDICATION;
4583
4584         /** Preference key for task color */
4585         protected final static String TASK_INDICATION_COLOR = PreferenceConstants.EDITOR_TASK_INDICATION_COLOR;
4586
4587         /** Preference key for bookmark indication */
4588         protected final static String BOOKMARK_INDICATION = PreferenceConstants.EDITOR_BOOKMARK_INDICATION;
4589
4590         /** Preference key for bookmark color */
4591         protected final static String BOOKMARK_INDICATION_COLOR = PreferenceConstants.EDITOR_BOOKMARK_INDICATION_COLOR;
4592
4593         /** Preference key for search result indication */
4594         protected final static String SEARCH_RESULT_INDICATION = PreferenceConstants.EDITOR_SEARCH_RESULT_INDICATION;
4595
4596         /** Preference key for search result color */
4597         protected final static String SEARCH_RESULT_INDICATION_COLOR = PreferenceConstants.EDITOR_SEARCH_RESULT_INDICATION_COLOR;
4598
4599         /** Preference key for unknown annotation indication */
4600         protected final static String UNKNOWN_INDICATION = PreferenceConstants.EDITOR_UNKNOWN_INDICATION;
4601
4602         /** Preference key for unknown annotation color */
4603         protected final static String UNKNOWN_INDICATION_COLOR = PreferenceConstants.EDITOR_UNKNOWN_INDICATION_COLOR;
4604
4605         /** Preference key for shwoing the overview ruler */
4606         protected final static String OVERVIEW_RULER = PreferenceConstants.EDITOR_OVERVIEW_RULER;
4607
4608         /** Preference key for error indication in overview ruler */
4609         protected final static String ERROR_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_ERROR_INDICATION_IN_OVERVIEW_RULER;
4610
4611         /** Preference key for warning indication in overview ruler */
4612         protected final static String WARNING_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_WARNING_INDICATION_IN_OVERVIEW_RULER;
4613
4614         /** Preference key for task indication in overview ruler */
4615         protected final static String TASK_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_TASK_INDICATION_IN_OVERVIEW_RULER;
4616
4617         /** Preference key for bookmark indication in overview ruler */
4618         protected final static String BOOKMARK_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_BOOKMARK_INDICATION_IN_OVERVIEW_RULER;
4619
4620         /** Preference key for search result indication in overview ruler */
4621         protected final static String SEARCH_RESULT_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_SEARCH_RESULT_INDICATION_IN_OVERVIEW_RULER;
4622
4623         /** Preference key for unknown annotation indication in overview ruler */
4624         protected final static String UNKNOWN_INDICATION_IN_OVERVIEW_RULER = PreferenceConstants.EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER;
4625
4626         // /** Preference key for compiler task tags */
4627         // private final static String COMPILER_TASK_TAGS=
4628         // JavaCore.COMPILER_TASK_TAGS;
4629         /** Preference key for browser like links */
4630         private final static String BROWSER_LIKE_LINKS = PreferenceConstants.EDITOR_BROWSER_LIKE_LINKS;
4631
4632         /** Preference key for key modifier of browser like links */
4633         private final static String BROWSER_LIKE_LINKS_KEY_MODIFIER = PreferenceConstants.EDITOR_BROWSER_LIKE_LINKS_KEY_MODIFIER;
4634
4635         /**
4636          * Preference key for key modifier mask of browser like links. The value is
4637          * only used if the value of <code>EDITOR_BROWSER_LIKE_LINKS</code> cannot
4638          * be resolved to valid SWT modifier bits.
4639          *
4640          * @since 2.1.1
4641          */
4642         private final static String BROWSER_LIKE_LINKS_KEY_MODIFIER_MASK = PreferenceConstants.EDITOR_BROWSER_LIKE_LINKS_KEY_MODIFIER_MASK;
4643
4644         private final static char[] BRACKETS = { '{', '}', '(', ')', '[', ']' };
4645
4646         private static boolean isBracket(char character) {
4647                 for (int i = 0; i != BRACKETS.length; ++i)
4648                         if (character == BRACKETS[i])
4649                                 return true;
4650                 return false;
4651         }
4652
4653         private static boolean isSurroundedByBrackets(IDocument document, int offset) {
4654                 if (offset == 0 || offset == document.getLength())
4655                         return false;
4656
4657                 try {
4658                         return isBracket(document.getChar(offset - 1)) && isBracket(document.getChar(offset));
4659
4660                 } catch (BadLocationException e) {
4661                         return false;
4662                 }
4663         }
4664
4665         // protected void configureSourceViewerDecorationSupport() {
4666         //
4667         // fSourceViewerDecorationSupport.setCharacterPairMatcher(fBracketMatcher);
4668         //
4669         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4670         // AnnotationType.UNKNOWN,
4671         // UNKNOWN_INDICATION_COLOR,
4672         // UNKNOWN_INDICATION,
4673         // UNKNOWN_INDICATION_IN_OVERVIEW_RULER,
4674         // 0);
4675         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4676         // AnnotationType.BOOKMARK,
4677         // BOOKMARK_INDICATION_COLOR,
4678         // BOOKMARK_INDICATION,
4679         // BOOKMARK_INDICATION_IN_OVERVIEW_RULER,
4680         // 1);
4681         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4682         // AnnotationType.TASK,
4683         // TASK_INDICATION_COLOR,
4684         // TASK_INDICATION,
4685         // TASK_INDICATION_IN_OVERVIEW_RULER,
4686         // 2);
4687         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4688         // AnnotationType.SEARCH,
4689         // SEARCH_RESULT_INDICATION_COLOR,
4690         // SEARCH_RESULT_INDICATION,
4691         // SEARCH_RESULT_INDICATION_IN_OVERVIEW_RULER,
4692         // 3);
4693         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4694         // AnnotationType.WARNING,
4695         // WARNING_INDICATION_COLOR,
4696         // WARNING_INDICATION,
4697         // WARNING_INDICATION_IN_OVERVIEW_RULER,
4698         // 4);
4699         // fSourceViewerDecorationSupport.setAnnotationPainterPreferenceKeys(
4700         // AnnotationType.ERROR,
4701         // ERROR_INDICATION_COLOR,
4702         // ERROR_INDICATION,
4703         // ERROR_INDICATION_IN_OVERVIEW_RULER,
4704         // 5);
4705         //
4706         // fSourceViewerDecorationSupport.setCursorLinePainterPreferenceKeys(CURRENT_LINE,
4707         // CURRENT_LINE_COLOR);
4708         // fSourceViewerDecorationSupport.setMarginPainterPreferenceKeys(PRINT_MARGIN,
4709         // PRINT_MARGIN_COLOR, PRINT_MARGIN_COLUMN);
4710         // fSourceViewerDecorationSupport.setMatchingCharacterPainterPreferenceKeys(MATCHING_BRACKETS,
4711         // MATCHING_BRACKETS_COLOR);
4712         //
4713         // fSourceViewerDecorationSupport.setSymbolicFontName(getFontPropertyPreferenceKey());
4714         //
4715         // }
4716         /**
4717          * Returns the Java element wrapped by this editors input.
4718          *
4719          * @return the Java element wrapped by this editors input.
4720          * @since 3.0
4721          */
4722         abstract protected IJavaElement getInputJavaElement();
4723
4724         protected void updateStatusLine() {
4725                 ITextSelection selection = (ITextSelection) getSelectionProvider().getSelection();
4726                 Annotation annotation = getAnnotation(selection.getOffset(), selection.getLength());
4727                 setStatusLineErrorMessage(null);
4728                 setStatusLineMessage(null);
4729                 if (annotation != null) {
4730                         try {
4731                                 fIsUpdatingAnnotationViews = true;
4732                                 updateAnnotationViews(annotation);
4733                         } finally {
4734                                 fIsUpdatingAnnotationViews = false;
4735                         }
4736                         if (annotation instanceof IJavaAnnotation && ((IJavaAnnotation) annotation).isProblem())
4737                                 setStatusLineMessage(annotation.getText());
4738                 }
4739         }
4740
4741         /**
4742          * Jumps to the matching bracket.
4743          */
4744         public void gotoMatchingBracket() {
4745
4746                 ISourceViewer sourceViewer = getSourceViewer();
4747                 IDocument document = sourceViewer.getDocument();
4748                 if (document == null)
4749                         return;
4750
4751                 IRegion selection = getSignedSelection(sourceViewer);
4752
4753                 int selectionLength = Math.abs(selection.getLength());
4754                 if (selectionLength > 1) {
4755                         setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.invalidSelection")); //$NON-NLS-1$
4756                         sourceViewer.getTextWidget().getDisplay().beep();
4757                         return;
4758                 }
4759
4760                 // #26314
4761                 int sourceCaretOffset = selection.getOffset() + selection.getLength();
4762                 if (isSurroundedByBrackets(document, sourceCaretOffset))
4763                         sourceCaretOffset -= selection.getLength();
4764
4765                 IRegion region = fBracketMatcher.match(document, sourceCaretOffset);
4766                 if (region == null) {
4767                         setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.noMatchingBracket")); //$NON-NLS-1$
4768                         sourceViewer.getTextWidget().getDisplay().beep();
4769                         return;
4770                 }
4771
4772                 int offset = region.getOffset();
4773                 int length = region.getLength();
4774
4775                 if (length < 1)
4776                         return;
4777
4778                 int anchor = fBracketMatcher.getAnchor();
4779                 int targetOffset = (PHPPairMatcher.RIGHT == anchor) ? offset : offset + length - 1;
4780
4781                 boolean visible = false;
4782                 if (sourceViewer instanceof ITextViewerExtension3) {
4783                         ITextViewerExtension3 extension = (ITextViewerExtension3) sourceViewer;
4784                         visible = (extension.modelOffset2WidgetOffset(targetOffset) > -1);
4785                 } else {
4786                         IRegion visibleRegion = sourceViewer.getVisibleRegion();
4787                         visible = (targetOffset >= visibleRegion.getOffset() && targetOffset < visibleRegion.getOffset() + visibleRegion.getLength());
4788                 }
4789
4790                 if (!visible) {
4791                         setStatusLineErrorMessage(PHPEditorMessages.getString("GotoMatchingBracket.error.bracketOutsideSelectedElement")); //$NON-NLS-1$
4792                         sourceViewer.getTextWidget().getDisplay().beep();
4793                         return;
4794                 }
4795
4796                 if (selection.getLength() < 0)
4797                         targetOffset -= selection.getLength();
4798
4799                 sourceViewer.setSelectedRange(targetOffset, selection.getLength());
4800                 sourceViewer.revealRange(targetOffset, selection.getLength());
4801         }
4802
4803         /**
4804          * Ses the given message as error message to this editor's status line.
4805          *
4806          * @param msg
4807          *          message to be set
4808          */
4809         protected void setStatusLineErrorMessage(String msg) {
4810                 IEditorStatusLine statusLine = (IEditorStatusLine) getAdapter(IEditorStatusLine.class);
4811                 if (statusLine != null)
4812                         statusLine.setMessage(true, msg, null);
4813         }
4814
4815         /**
4816          * Sets the given message as message to this editor's status line.
4817          *
4818          * @param msg
4819          *          message to be set
4820          * @since 3.0
4821          */
4822         protected void setStatusLineMessage(String msg) {
4823                 IEditorStatusLine statusLine = (IEditorStatusLine) getAdapter(IEditorStatusLine.class);
4824                 if (statusLine != null)
4825                         statusLine.setMessage(false, msg, null);
4826         }
4827
4828         /**
4829          * Returns the annotation closest to the given range respecting the given
4830          * direction. If an annotation is found, the annotations current position is
4831          * copied into the provided annotation position.
4832          *
4833          * @param offset
4834          *          the region offset
4835          * @param length
4836          *          the region length
4837          * @param forward
4838          *          <code>true</code> for forwards, <code>false</code> for
4839          *          backward
4840          * @param annotationPosition
4841          *          the position of the found annotation
4842          * @return the found annotation
4843          */
4844         private Annotation getNextAnnotation(final int offset, final int length, boolean forward, Position annotationPosition) {
4845
4846                 Annotation nextAnnotation = null;
4847                 Position nextAnnotationPosition = null;
4848                 Annotation containingAnnotation = null;
4849                 Position containingAnnotationPosition = null;
4850                 boolean currentAnnotation = false;
4851
4852                 IDocument document = getDocumentProvider().getDocument(getEditorInput());
4853                 int endOfDocument = document.getLength();
4854                 int distance = Integer.MAX_VALUE;
4855
4856                 IAnnotationModel model = getDocumentProvider().getAnnotationModel(getEditorInput());
4857                 Iterator e = new JavaAnnotationIterator(model, true, true);
4858                 while (e.hasNext()) {
4859                         Annotation a = (Annotation) e.next();
4860                         if ((a instanceof IJavaAnnotation) && ((IJavaAnnotation) a).hasOverlay() || !isNavigationTarget(a))
4861                                 continue;
4862
4863                         Position p = model.getPosition(a);
4864                         if (p == null)
4865                                 continue;
4866
4867                         if (forward && p.offset == offset || !forward && p.offset + p.getLength() == offset + length) {// ||
4868                                 // p.includes(offset))
4869                                 // {
4870                                 if (containingAnnotation == null
4871                                                 || (forward && p.length >= containingAnnotationPosition.length || !forward
4872                                                                 && p.length >= containingAnnotationPosition.length)) {
4873                                         containingAnnotation = a;
4874                                         containingAnnotationPosition = p;
4875                                         currentAnnotation = p.length == length;
4876                                 }
4877                         } else {
4878                                 int currentDistance = 0;
4879
4880                                 if (forward) {
4881                                         currentDistance = p.getOffset() - offset;
4882                                         if (currentDistance < 0)
4883                                                 currentDistance = endOfDocument + currentDistance;
4884
4885                                         if (currentDistance < distance || currentDistance == distance && p.length < nextAnnotationPosition.length) {
4886                                                 distance = currentDistance;
4887                                                 nextAnnotation = a;
4888                                                 nextAnnotationPosition = p;
4889                                         }
4890                                 } else {
4891                                         currentDistance = offset + length - (p.getOffset() + p.length);
4892                                         if (currentDistance < 0)
4893                                                 currentDistance = endOfDocument + currentDistance;
4894
4895                                         if (currentDistance < distance || currentDistance == distance && p.length < nextAnnotationPosition.length) {
4896                                                 distance = currentDistance;
4897                                                 nextAnnotation = a;
4898                                                 nextAnnotationPosition = p;
4899                                         }
4900                                 }
4901                         }
4902                 }
4903                 if (containingAnnotationPosition != null && (!currentAnnotation || nextAnnotation == null)) {
4904                         annotationPosition.setOffset(containingAnnotationPosition.getOffset());
4905                         annotationPosition.setLength(containingAnnotationPosition.getLength());
4906                         return containingAnnotation;
4907                 }
4908                 if (nextAnnotationPosition != null) {
4909                         annotationPosition.setOffset(nextAnnotationPosition.getOffset());
4910                         annotationPosition.setLength(nextAnnotationPosition.getLength());
4911                 }
4912
4913                 return nextAnnotation;
4914         }
4915
4916         /**
4917          * Returns the annotation overlapping with the given range or
4918          * <code>null</code>.
4919          *
4920          * @param offset
4921          *          the region offset
4922          * @param length
4923          *          the region length
4924          * @return the found annotation or <code>null</code>
4925          * @since 3.0
4926          */
4927         private Annotation getAnnotation(int offset, int length) {
4928                 IAnnotationModel model = getDocumentProvider().getAnnotationModel(getEditorInput());
4929                 Iterator e = new JavaAnnotationIterator(model, true, true);
4930                 while (e.hasNext()) {
4931                         Annotation a = (Annotation) e.next();
4932                         if (!isNavigationTarget(a))
4933                                 continue;
4934
4935                         Position p = model.getPosition(a);
4936                         if (p != null && p.overlapsWith(offset, length))
4937                                 return a;
4938                 }
4939
4940                 return null;
4941         }
4942
4943         /**
4944          * Returns whether the given annotation is configured as a target for the "Go
4945          * to Next/Previous Annotation" actions
4946          *
4947          * @param annotation
4948          *          the annotation
4949          * @return <code>true</code> if this is a target, <code>false</code>
4950          *         otherwise
4951          * @since 3.0
4952          */
4953         private boolean isNavigationTarget(Annotation annotation) {
4954                 Preferences preferences = EditorsUI.getPluginPreferences();
4955                 AnnotationPreference preference = getAnnotationPreferenceLookup().getAnnotationPreference(annotation);
4956                 // See bug 41689
4957                 // String key= forward ? preference.getIsGoToNextNavigationTargetKey() :
4958                 // preference.getIsGoToPreviousNavigationTargetKey();
4959                 String key = preference == null ? null : preference.getIsGoToNextNavigationTargetKey();
4960                 return (key != null && preferences.getBoolean(key));
4961         }
4962
4963         /**
4964          * Returns a segmentation of the line of the given document appropriate for
4965          * bidi rendering. The default implementation returns only the string literals
4966          * of a php code line as segments.
4967          *
4968          * @param document
4969          *          the document
4970          * @param lineOffset
4971          *          the offset of the line
4972          * @return the line's bidi segmentation
4973          * @throws BadLocationException
4974          *           in case lineOffset is not valid in document
4975          */
4976         public static int[] getBidiLineSegments(IDocument document, int lineOffset) throws BadLocationException {
4977
4978                 IRegion line = document.getLineInformationOfOffset(lineOffset);
4979                 ITypedRegion[] linePartitioning = document.computePartitioning(lineOffset, line.getLength());
4980
4981                 List segmentation = new ArrayList();
4982                 for (int i = 0; i < linePartitioning.length; i++) {
4983                         if (IPHPPartitions.PHP_STRING_DQ.equals(linePartitioning[i].getType())) {
4984                                 segmentation.add(linePartitioning[i]);
4985                         } else if (IPHPPartitions.PHP_STRING_HEREDOC.equals(linePartitioning[i].getType())) {
4986                                 segmentation.add(linePartitioning[i]);
4987                         }
4988                 }
4989
4990                 if (segmentation.size() == 0)
4991                         return null;
4992
4993                 int size = segmentation.size();
4994                 int[] segments = new int[size * 2 + 1];
4995
4996                 int j = 0;
4997                 for (int i = 0; i < size; i++) {
4998                         ITypedRegion segment = (ITypedRegion) segmentation.get(i);
4999
5000                         if (i == 0)
5001                                 segments[j++] = 0;
5002
5003                         int offset = segment.getOffset() - lineOffset;
5004                         if (offset > segments[j - 1])
5005                                 segments[j++] = offset;
5006
5007                         if (offset + segment.getLength() >= line.getLength())
5008                                 break;
5009
5010                         segments[j++] = offset + segment.getLength();
5011                 }
5012
5013                 if (j < segments.length) {
5014                         int[] result = new int[j];
5015                         System.arraycopy(segments, 0, result, 0, j);
5016                         segments = result;
5017                 }
5018
5019                 return segments;
5020         }
5021
5022         /**
5023          * Returns a segmentation of the given line appropriate for bidi rendering.
5024          * The default implementation returns only the string literals of a php code
5025          * line as segments.
5026          *
5027          * @param lineOffset
5028          *          the offset of the line
5029          * @param line
5030          *          the content of the line
5031          * @return the line's bidi segmentation
5032          */
5033         protected int[] getBidiLineSegments(int lineOffset, String line) {
5034                 IDocumentProvider provider = getDocumentProvider();
5035                 if (provider != null && line != null && line.length() > 0) {
5036                         IDocument document = provider.getDocument(getEditorInput());
5037                         if (document != null)
5038                                 try {
5039                                         return getBidiLineSegments(document, lineOffset);
5040                                 } catch (BadLocationException x) {
5041                                         // ignore
5042                                 }
5043                 }
5044                 return null;
5045         }
5046
5047         /*
5048          * @see AbstractTextEditor#createSourceViewer(Composite, IVerticalRuler, int)
5049          */
5050         // protected final ISourceViewer createSourceViewer(
5051         // Composite parent,
5052         // IVerticalRuler ruler,
5053         // int styles) {
5054         // ISourceViewer viewer = createJavaSourceViewer(parent, ruler, styles);
5055         // StyledText text = viewer.getTextWidget();
5056         // text.addBidiSegmentListener(new BidiSegmentListener() {
5057         // public void lineGetSegments(BidiSegmentEvent event) {
5058         // event.segments = getBidiLineSegments(event.lineOffset, event.lineText);
5059         // }
5060         // });
5061         // // JavaUIHelp.setHelp(this, text, IJavaHelpContextIds.JAVA_EDITOR);
5062         // return viewer;
5063         // }
5064         public final ISourceViewer getViewer() {
5065                 return getSourceViewer();
5066         }
5067
5068         // protected void showOverviewRuler() {
5069         // if (fOverviewRuler != null) {
5070         // if (getSourceViewer() instanceof ISourceViewerExtension) {
5071         // ((ISourceViewerExtension)
5072         // getSourceViewer()).showAnnotationsOverview(true);
5073         // fSourceViewerDecorationSupport.updateOverviewDecorations();
5074         // }
5075         // }
5076         // }
5077         //
5078         // protected void hideOverviewRuler() {
5079         // if (getSourceViewer() instanceof ISourceViewerExtension) {
5080         // fSourceViewerDecorationSupport.hideAnnotationOverview();
5081         // ((ISourceViewerExtension)
5082         // getSourceViewer()).showAnnotationsOverview(false);
5083         // }
5084         // }
5085
5086         // protected boolean isOverviewRulerVisible() {
5087         // IPreferenceStore store = getPreferenceStore();
5088         // return store.getBoolean(OVERVIEW_RULER);
5089         // }
5090         /*
5091          * @see AbstractTextEditor#createSourceViewer(Composite, IVerticalRuler, int)
5092          */
5093         // protected ISourceViewer createJavaSourceViewer(
5094         // Composite parent,
5095         // IVerticalRuler ruler,
5096         // IOverviewRuler overviewRuler,
5097         // boolean isOverviewRulerVisible,
5098         // int styles) {
5099         // return new SourceViewer(parent, ruler, overviewRuler,
5100         // isOverviewRulerVisible(), styles);
5101         // }
5102         /*
5103          * @see AbstractTextEditor#createSourceViewer(Composite, IVerticalRuler, int)
5104          */
5105         protected ISourceViewer createJavaSourceViewer(Composite parent, IVerticalRuler verticalRuler, IOverviewRuler overviewRuler,
5106                         boolean isOverviewRulerVisible, int styles, IPreferenceStore store) {
5107                 return new JavaSourceViewer(parent, verticalRuler, getOverviewRuler(), isOverviewRulerVisible(), styles, store);
5108         }
5109
5110         /*
5111          * @see AbstractTextEditor#createSourceViewer(Composite, IVerticalRuler, int)
5112          */
5113         protected final ISourceViewer createSourceViewer(Composite parent, IVerticalRuler verticalRuler, int styles) {
5114
5115                 ISourceViewer viewer = createJavaSourceViewer(parent, verticalRuler, getOverviewRuler(), isOverviewRulerVisible(), styles,
5116                                 getPreferenceStore());
5117
5118                 StyledText text = viewer.getTextWidget();
5119                 text.addBidiSegmentListener(new BidiSegmentListener() {
5120                         public void lineGetSegments(BidiSegmentEvent event) {
5121                                 event.segments = getBidiLineSegments(event.lineOffset, event.lineText);
5122                         }
5123                 });
5124
5125                 // JavaUIHelp.setHelp(this, text, IJavaHelpContextIds.JAVA_EDITOR);
5126
5127                 // ensure source viewer decoration support has been created and
5128                 // configured
5129                 getSourceViewerDecorationSupport(viewer);
5130
5131                 return viewer;
5132         }
5133
5134         /*
5135          * @see AbstractTextEditor#affectsTextPresentation(PropertyChangeEvent)
5136          */
5137         protected boolean affectsTextPresentation(PropertyChangeEvent event) {
5138                 return ((PHPSourceViewerConfiguration) getSourceViewerConfiguration()).affectsTextPresentation(event)
5139                                 || super.affectsTextPresentation(event);
5140         }
5141
5142         //
5143         // protected boolean affectsTextPresentation(PropertyChangeEvent event) {
5144         // JavaTextTools textTools = PHPeclipsePlugin.getDefault().getJavaTextTools();
5145         // return textTools.affectsBehavior(event);
5146         // }
5147         /**
5148          * Creates and returns the preference store for this Java editor with the
5149          * given input.
5150          *
5151          * @param input
5152          *          The editor input for which to create the preference store
5153          * @return the preference store for this editor
5154          *
5155          * @since 3.0
5156          */
5157         private IPreferenceStore createCombinedPreferenceStore(IEditorInput input) {
5158                 List stores = new ArrayList(3);
5159
5160                 IJavaProject project = EditorUtility.getJavaProject(input);
5161                 if (project != null)
5162                         stores.add(new OptionsAdapter(project.getOptions(false), PHPeclipsePlugin.getDefault().getMockupPreferenceStore(),
5163                                         new OptionsAdapter.IPropertyChangeEventFilter() {
5164
5165                                                 public boolean isFiltered(PropertyChangeEvent event) {
5166                                                         IJavaElement inputJavaElement = getInputJavaElement();
5167                                                         IJavaProject javaProject = inputJavaElement != null ? inputJavaElement.getJavaProject() : null;
5168                                                         if (javaProject == null)
5169                                                                 return true;
5170
5171                                                         return !javaProject.getProject().equals(event.getSource());
5172                                                 }
5173
5174                                         }));
5175
5176                 stores.add(PHPeclipsePlugin.getDefault().getPreferenceStore());
5177                 stores.add(new PreferencesAdapter(JavaCore.getPlugin().getPluginPreferences()));
5178                 stores.add(EditorsUI.getPreferenceStore());
5179
5180                 return new ChainedPreferenceStore((IPreferenceStore[]) stores.toArray(new IPreferenceStore[stores.size()]));
5181         }
5182
5183         /**
5184          * Jumps to the error next according to the given direction.
5185          */
5186         public void gotoError(boolean forward) {
5187
5188                 ISelectionProvider provider = getSelectionProvider();
5189
5190                 ITextSelection s = (ITextSelection) provider.getSelection();
5191                 Position errorPosition = new Position(0, 0);
5192                 IJavaAnnotation nextError = getNextError(s.getOffset(), forward, errorPosition);
5193
5194                 if (nextError != null) {
5195
5196                         IMarker marker = null;
5197                         if (nextError instanceof MarkerAnnotation)
5198                                 marker = ((MarkerAnnotation) nextError).getMarker();
5199                         else {
5200                                 Iterator e = nextError.getOverlaidIterator();
5201                                 if (e != null) {
5202                                         while (e.hasNext()) {
5203                                                 Object o = e.next();
5204                                                 if (o instanceof MarkerAnnotation) {
5205                                                         marker = ((MarkerAnnotation) o).getMarker();
5206                                                         break;
5207                                                 }
5208                                         }
5209                                 }
5210                         }
5211
5212                         if (marker != null) {
5213                                 IWorkbenchPage page = getSite().getPage();
5214                                 IViewPart view = view = page.findView("org.eclipse.ui.views.TaskList"); //$NON-NLS-1$
5215                                 if (view instanceof TaskList) {
5216                                         StructuredSelection ss = new StructuredSelection(marker);
5217                                         ((TaskList) view).setSelection(ss, true);
5218                                 }
5219                         }
5220
5221                         selectAndReveal(errorPosition.getOffset(), errorPosition.getLength());
5222                         // setStatusLineErrorMessage(nextError.getMessage());
5223
5224                 } else {
5225
5226                         setStatusLineErrorMessage(null);
5227
5228                 }
5229         }
5230
5231         private IJavaAnnotation getNextError(int offset, boolean forward, Position errorPosition) {
5232
5233                 IJavaAnnotation nextError = null;
5234                 Position nextErrorPosition = null;
5235
5236                 IDocument document = getDocumentProvider().getDocument(getEditorInput());
5237                 int endOfDocument = document.getLength();
5238                 int distance = 0;
5239
5240                 IAnnotationModel model = getDocumentProvider().getAnnotationModel(getEditorInput());
5241                 Iterator e = new JavaAnnotationIterator(model, false);
5242                 while (e.hasNext()) {
5243
5244                         IJavaAnnotation a = (IJavaAnnotation) e.next();
5245                         if (a.hasOverlay() || !a.isProblem())
5246                                 continue;
5247
5248                         Position p = model.getPosition((Annotation) a);
5249                         if (!p.includes(offset)) {
5250
5251                                 int currentDistance = 0;
5252
5253                                 if (forward) {
5254                                         currentDistance = p.getOffset() - offset;
5255                                         if (currentDistance < 0)
5256                                                 currentDistance = endOfDocument - offset + p.getOffset();
5257                                 } else {
5258                                         currentDistance = offset - p.getOffset();
5259                                         if (currentDistance < 0)
5260                                                 currentDistance = offset + endOfDocument - p.getOffset();
5261                                 }
5262
5263                                 if (nextError == null || currentDistance < distance) {
5264                                         distance = currentDistance;
5265                                         nextError = a;
5266                                         nextErrorPosition = p;
5267                                 }
5268                         }
5269                 }
5270
5271                 if (nextErrorPosition != null) {
5272                         errorPosition.setOffset(nextErrorPosition.getOffset());
5273                         errorPosition.setLength(nextErrorPosition.getLength());
5274                 }
5275
5276                 return nextError;
5277         }
5278
5279         protected void uninstallOverrideIndicator() {
5280                 // if (fOverrideIndicatorManager != null) {
5281                 // fOverrideIndicatorManager.removeAnnotations();
5282                 // fOverrideIndicatorManager= null;
5283                 // }
5284         }
5285
5286         protected void installOverrideIndicator(boolean waitForReconcilation) {
5287                 uninstallOverrideIndicator();
5288                 IAnnotationModel model = getDocumentProvider().getAnnotationModel(getEditorInput());
5289                 final IJavaElement inputElement = getInputJavaElement();
5290
5291                 if (model == null || inputElement == null)
5292                         return;
5293
5294                 // fOverrideIndicatorManager= new OverrideIndicatorManager(model,
5295                 // inputElement, null);
5296                 //
5297                 // if (provideAST) {
5298                 // Job job= new
5299                 // Job(JavaEditorMessages.getString("OverrideIndicatorManager.intallJob")) {
5300                 // //$NON-NLS-1$
5301                 // /*
5302                 // * @see
5303                 // org.eclipse.core.runtime.jobs.Job#run(org.eclipse.core.runtime.IProgressMonitor)
5304                 // * @since 3.0
5305                 // */
5306                 // protected IStatus run(IProgressMonitor monitor) {
5307                 // CompilationUnit ast=
5308                 // JavaPlugin.getDefault().getASTProvider().getAST(inputElement, true,
5309                 // null);
5310                 // if (fOverrideIndicatorManager != null) // editor might have been closed
5311                 // in the meanwhile
5312                 // fOverrideIndicatorManager.reconciled(ast, true, monitor);
5313                 // return Status.OK_STATUS;
5314                 // }
5315                 // };
5316                 // job.setPriority(Job.DECORATE);
5317                 // job.setSystem(true);
5318                 // job.schedule();
5319                 // }
5320         }
5321
5322         /**
5323          * Tells whether override indicators are shown.
5324          *
5325          * @return <code>true</code> if the override indicators are shown
5326          * @since 3.0
5327          */
5328         // protected boolean isShowingOverrideIndicators() {
5329         // AnnotationPreference preference=
5330         // getAnnotationPreferenceLookup().getAnnotationPreference(OverrideIndicatorManager.ANNOTATION_TYPE);
5331         // IPreferenceStore store= getPreferenceStore();
5332         // return getBoolean(store, preference.getHighlightPreferenceKey())
5333         // || getBoolean(store, preference.getVerticalRulerPreferenceKey())
5334         // || getBoolean(store, preference.getOverviewRulerPreferenceKey())
5335         // || getBoolean(store, preference.getTextPreferenceKey());
5336         // }
5337         /**
5338          * Returns the boolean preference for the given key.
5339          *
5340          * @param store
5341          *          the preference store
5342          * @param key
5343          *          the preference key
5344          * @return <code>true</code> if the key exists in the store and its value is
5345          *         <code>true</code>
5346          * @since 3.0
5347          */
5348         private boolean getBoolean(IPreferenceStore store, String key) {
5349                 return key != null && store.getBoolean(key);
5350         }
5351
5352         protected boolean isPrefQuickDiffAlwaysOn() {
5353                 return false; // never show change ruler for the non-editable java editor.
5354                 // Overridden in subclasses like PHPUnitEditor
5355         }
5356
5357         /*
5358          * @see org.eclipse.ui.texteditor.AbstractTextEditor#createNavigationActions()
5359          */
5360         protected void createNavigationActions() {
5361                 super.createNavigationActions();
5362
5363                 final StyledText textWidget = getSourceViewer().getTextWidget();
5364
5365                 IAction action = new SmartLineStartAction(textWidget, false);
5366                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.LINE_START);
5367                 setAction(ITextEditorActionDefinitionIds.LINE_START, action);
5368
5369                 action = new SmartLineStartAction(textWidget, true);
5370                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.SELECT_LINE_START);
5371                 setAction(ITextEditorActionDefinitionIds.SELECT_LINE_START, action);
5372
5373                 action = new NavigatePreviousSubWordAction();
5374                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.WORD_PREVIOUS);
5375                 setAction(ITextEditorActionDefinitionIds.WORD_PREVIOUS, action);
5376                 textWidget.setKeyBinding(SWT.CTRL | SWT.ARROW_LEFT, SWT.NULL);
5377
5378                 action = new NavigateNextSubWordAction();
5379                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.WORD_NEXT);
5380                 setAction(ITextEditorActionDefinitionIds.WORD_NEXT, action);
5381                 textWidget.setKeyBinding(SWT.CTRL | SWT.ARROW_RIGHT, SWT.NULL);
5382
5383                 action = new SelectPreviousSubWordAction();
5384                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.SELECT_WORD_PREVIOUS);
5385                 setAction(ITextEditorActionDefinitionIds.SELECT_WORD_PREVIOUS, action);
5386                 textWidget.setKeyBinding(SWT.CTRL | SWT.SHIFT | SWT.ARROW_LEFT, SWT.NULL);
5387
5388                 action = new SelectNextSubWordAction();
5389                 action.setActionDefinitionId(ITextEditorActionDefinitionIds.SELECT_WORD_NEXT);
5390                 setAction(ITextEditorActionDefinitionIds.SELECT_WORD_NEXT, action);
5391                 textWidget.setKeyBinding(SWT.CTRL | SWT.SHIFT | SWT.ARROW_RIGHT, SWT.NULL);
5392         }
5393
5394         /*
5395          * @see org.eclipse.ui.texteditor.AbstractDecoratedTextEditor#createCompositeRuler()
5396          */
5397         protected CompositeRuler createCompositeRuler() {
5398                 if (!getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_ANNOTATION_ROLL_OVER))
5399                         return super.createCompositeRuler();
5400
5401                 CompositeRuler ruler = new CompositeRuler();
5402                 AnnotationRulerColumn column = new AnnotationRulerColumn(VERTICAL_RULER_WIDTH, getAnnotationAccess());
5403                 column.setHover(new JavaExpandHover(ruler, getAnnotationAccess(), new IDoubleClickListener() {
5404
5405                         public void doubleClick(DoubleClickEvent event) {
5406                                 // for now: just invoke ruler double click action
5407                                 triggerAction(ITextEditorActionConstants.RULER_DOUBLE_CLICK);
5408                         }
5409
5410                         private void triggerAction(String actionID) {
5411                                 IAction action = getAction(actionID);
5412                                 if (action != null) {
5413                                         if (action instanceof IUpdate)
5414                                                 ((IUpdate) action).update();
5415                                         // hack to propagate line change
5416                                         if (action instanceof ISelectionListener) {
5417                                                 ((ISelectionListener) action).selectionChanged(null, null);
5418                                         }
5419                                         if (action.isEnabled())
5420                                                 action.run();
5421                                 }
5422                         }
5423
5424                 }));
5425                 ruler.addDecorator(0, column);
5426
5427                 if (isLineNumberRulerVisible())
5428                         ruler.addDecorator(1, createLineNumberRulerColumn());
5429                 else if (isPrefQuickDiffAlwaysOn())
5430                         ruler.addDecorator(1, createChangeRulerColumn());
5431
5432                 return ruler;
5433         }
5434
5435         /**
5436          * Returns the folding action group, or <code>null</code> if there is none.
5437          *
5438          * @return the folding action group, or <code>null</code> if there is none
5439          * @since 3.0
5440          */
5441         protected FoldingActionGroup getFoldingActionGroup() {
5442                 return fFoldingGroup;
5443         }
5444
5445         /*
5446          * @see org.eclipse.ui.texteditor.AbstractTextEditor#performRevert()
5447          */
5448         protected void performRevert() {
5449                 ProjectionViewer projectionViewer = (ProjectionViewer) getSourceViewer();
5450                 projectionViewer.setRedraw(false);
5451                 try {
5452
5453                         boolean projectionMode = projectionViewer.isProjectionMode();
5454                         if (projectionMode) {
5455                                 projectionViewer.disableProjection();
5456                                 if (fProjectionModelUpdater != null)
5457                                         fProjectionModelUpdater.uninstall();
5458                         }
5459
5460                         super.performRevert();
5461
5462                         if (projectionMode) {
5463                                 if (fProjectionModelUpdater != null)
5464                                         fProjectionModelUpdater.install(this, projectionViewer);
5465                                 projectionViewer.enableProjection();
5466                         }
5467
5468                 } finally {
5469                         projectionViewer.setRedraw(true);
5470                 }
5471         }
5472
5473         /**
5474          * React to changed selection.
5475          *
5476          * @since 3.0
5477          */
5478         protected void selectionChanged() {
5479                 if (getSelectionProvider() == null)
5480                         return;
5481                 ISourceReference element = computeHighlightRangeSourceReference();
5482                 if (getPreferenceStore().getBoolean(PreferenceConstants.EDITOR_SYNC_OUTLINE_ON_CURSOR_MOVE))
5483                         synchronizeOutlinePage(element);
5484                 setSelection(element, false);
5485                 updateStatusLine();
5486         }
5487
5488         private boolean isJavaOutlinePageActive() {
5489                 IWorkbenchPart part = getActivePart();
5490                 return part instanceof ContentOutline && ((ContentOutline) part).getCurrentPage() == fOutlinePage;
5491         }
5492
5493         private IWorkbenchPart getActivePart() {
5494                 IWorkbenchWindow window = getSite().getWorkbenchWindow();
5495                 IPartService service = window.getPartService();
5496                 IWorkbenchPart part = service.getActivePart();
5497                 return part;
5498         }
5499
5500         /**
5501          * Computes and returns the source reference that includes the caret and
5502          * serves as provider for the outline page selection and the editor range
5503          * indication.
5504          *
5505          * @return the computed source reference
5506          * @since 3.0
5507          */
5508         protected ISourceReference computeHighlightRangeSourceReference() {
5509                 ISourceViewer sourceViewer = getSourceViewer();
5510                 if (sourceViewer == null)
5511                         return null;
5512
5513                 StyledText styledText = sourceViewer.getTextWidget();
5514                 if (styledText == null)
5515                         return null;
5516
5517                 int caret = 0;
5518                 if (sourceViewer instanceof ITextViewerExtension5) {
5519                         ITextViewerExtension5 extension = (ITextViewerExtension5) sourceViewer;
5520                         caret = extension.widgetOffset2ModelOffset(styledText.getCaretOffset());
5521                 } else {
5522                         int offset = sourceViewer.getVisibleRegion().getOffset();
5523                         caret = offset + styledText.getCaretOffset();
5524                 }
5525
5526                 IJavaElement element = getElementAt(caret, false);
5527
5528                 if (!(element instanceof ISourceReference))
5529                         return null;
5530
5531                 if (element.getElementType() == IJavaElement.IMPORT_DECLARATION) {
5532
5533                         IImportDeclaration declaration = (IImportDeclaration) element;
5534                         IImportContainer container = (IImportContainer) declaration.getParent();
5535                         ISourceRange srcRange = null;
5536
5537                         try {
5538                                 srcRange = container.getSourceRange();
5539                         } catch (JavaModelException e) {
5540                         }
5541
5542                         if (srcRange != null && srcRange.getOffset() == caret)
5543                                 return container;
5544                 }
5545
5546                 return (ISourceReference) element;
5547         }
5548
5549         /**
5550          * Returns the most narrow java element including the given offset.
5551          *
5552          * @param offset
5553          *          the offset inside of the requested element
5554          * @param reconcile
5555          *          <code>true</code> if editor input should be reconciled in
5556          *          advance
5557          * @return the most narrow java element
5558          * @since 3.0
5559          */
5560         protected IJavaElement getElementAt(int offset, boolean reconcile) {
5561                 return getElementAt(offset);
5562         }
5563
5564         public ShowInContext getShowInContext() {
5565                 FileEditorInput fei = (FileEditorInput) getEditorInput();
5566                 ShowInContext context = BrowserUtil.getShowInContext(fei.getFile(), false, "");
5567                 if (context != null) {
5568                         return context;
5569                 }
5570                 return new ShowInContext(fei.getFile(), null);
5571         }
5572
5573         public String[] getShowInTargetIds() {
5574                 return new String[] { BrowserView.ID_BROWSER };
5575         }
5576
5577         /**
5578          * Updates the occurrences annotations based on the current selection.
5579          *
5580          * @param selection
5581          *          the text selection
5582          * @param astRoot
5583          *          the compilation unit AST
5584          * @since 3.0
5585          */
5586         protected void updateOccurrenceAnnotations(ITextSelection selection) {// ,
5587                                                                                                                                                                                                                                                                                                 // CompilationUnit
5588                                                                                                                                                                                                                                                                                                 // astRoot)
5589                                                                                                                                                                                                                                                                                                 // {
5590
5591                 if (fOccurrencesFinderJob != null)
5592                         fOccurrencesFinderJob.cancel();
5593
5594                 if (!fMarkOccurrenceAnnotations)
5595                         return;
5596
5597                 // if (astRoot == null || selection == null)
5598                 if (selection == null)
5599                         return;
5600
5601                 IDocument document = getSourceViewer().getDocument();
5602                 if (document == null)
5603                         return;
5604
5605                 fMarkOccurrenceTargetRegion = null;
5606                 if (document instanceof IDocumentExtension4) {
5607                         int offset = selection.getOffset();
5608                         long currentModificationStamp = ((IDocumentExtension4) document).getModificationStamp();
5609                         if (fMarkOccurrenceTargetRegion != null && currentModificationStamp == fMarkOccurrenceModificationStamp) {
5610                                 if (fMarkOccurrenceTargetRegion.getOffset() <= offset
5611                                                 && offset <= fMarkOccurrenceTargetRegion.getOffset() + fMarkOccurrenceTargetRegion.getLength())
5612                                         return;
5613                         }
5614                         fMarkOccurrenceTargetRegion = JavaWordFinder.findWord(document, offset);
5615                         fMarkOccurrenceModificationStamp = currentModificationStamp;
5616                 }
5617
5618                 if (fMarkOccurrenceTargetRegion == null) {
5619                         return;
5620                 }
5621
5622                 List matches = null;
5623
5624                 if (matches == null) {
5625                         try {
5626                                 matches = new ArrayList();
5627
5628                                 Scanner fScanner = new Scanner();
5629                                 fScanner.setSource(document.get().toCharArray());
5630                                 fScanner.setPHPMode(false);
5631                                 char[] word;
5632
5633                                 word = document.get(fMarkOccurrenceTargetRegion.getOffset(), fMarkOccurrenceTargetRegion.getLength()).toCharArray();
5634
5635                                 int fToken = ITerminalSymbols.TokenNameEOF;
5636                                 try {
5637                                         fToken = fScanner.getNextToken();
5638                                         while (fToken != ITerminalSymbols.TokenNameEOF) { // && fToken !=
5639                                                 // TokenNameERROR) {
5640                                                 if (fToken == ITerminalSymbols.TokenNameVariable || fToken == ITerminalSymbols.TokenNameIdentifier) {
5641                                                         // global variable
5642                                                         if (fScanner.equalsCurrentTokenSource(word)) {
5643                                                                 matches.add(new Region(fScanner.getCurrentTokenStartPosition(), fScanner.getCurrentTokenEndPosition()
5644                                                                                 - fScanner.getCurrentTokenStartPosition() + 1));
5645                                                         }
5646                                                 }
5647                                                 fToken = fScanner.getNextToken();
5648                                         }
5649                                 } catch (InvalidInputException e) {
5650                                         // ignore errors
5651                                 } catch (SyntaxError e) {
5652                                         // ignore errors
5653                                 }
5654
5655                         } catch (BadLocationException e1) {
5656                                 // ignore errors
5657                         } catch (Exception e) {
5658                                 e.printStackTrace();
5659                                 // ignore errors
5660                         }
5661
5662                 }
5663
5664                 if (matches == null || matches.size() == 0) {
5665                         if (!fStickyOccurrenceAnnotations)
5666                                 removeOccurrenceAnnotations();
5667                         return;
5668                 }
5669
5670                 Position[] positions = new Position[matches.size()];
5671                 int i = 0;
5672                 for (Iterator each = matches.iterator(); each.hasNext();) {
5673                         IRegion currentNode = (IRegion) each.next();
5674                         positions[i++] = new Position(currentNode.getOffset(), currentNode.getLength());
5675                 }
5676
5677                 fOccurrencesFinderJob = new OccurrencesFinderJob(document, positions, selection);
5678                 // fOccurrencesFinderJob.setPriority(Job.DECORATE);
5679                 // fOccurrencesFinderJob.setSystem(true);
5680                 // fOccurrencesFinderJob.schedule();
5681                 fOccurrencesFinderJob.run(new NullProgressMonitor());
5682         }
5683
5684         protected void installOccurrencesFinder() {
5685                 fMarkOccurrenceAnnotations = true;
5686
5687                 fPostSelectionListenerWithAST = new ISelectionListenerWithAST() {
5688                         public void selectionChanged(IEditorPart part, ITextSelection selection) { // ,
5689                                                                                                                                                                                                                                                                                                                                         // CompilationUnit
5690                                                                                                                                                                                                                                                                                                                                         // astRoot)
5691                                                                                                                                                                                                                                                                                                                                         // {
5692                                 updateOccurrenceAnnotations(selection);// , astRoot);
5693                         }
5694                 };
5695                 SelectionListenerWithASTManager.getDefault().addListener(this, fPostSelectionListenerWithAST);
5696                 if (getSelectionProvider() != null) {
5697                         fForcedMarkOccurrencesSelection = getSelectionProvider().getSelection();
5698                         SelectionListenerWithASTManager.getDefault().forceSelectionChange(this, (ITextSelection) fForcedMarkOccurrencesSelection);
5699                 }
5700
5701                 if (fOccurrencesFinderJobCanceler == null) {
5702                         fOccurrencesFinderJobCanceler = new OccurrencesFinderJobCanceler();
5703                         fOccurrencesFinderJobCanceler.install();
5704                 }
5705         }
5706
5707         protected void uninstallOccurrencesFinder() {
5708                 fMarkOccurrenceAnnotations = false;
5709
5710                 if (fOccurrencesFinderJob != null) {
5711                         fOccurrencesFinderJob.cancel();
5712                         fOccurrencesFinderJob = null;
5713                 }
5714
5715                 if (fOccurrencesFinderJobCanceler != null) {
5716                         fOccurrencesFinderJobCanceler.uninstall();
5717                         fOccurrencesFinderJobCanceler = null;
5718                 }
5719
5720                 if (fPostSelectionListenerWithAST != null) {
5721                         SelectionListenerWithASTManager.getDefault().removeListener(this, fPostSelectionListenerWithAST);
5722                         fPostSelectionListenerWithAST = null;
5723                 }
5724
5725                 removeOccurrenceAnnotations();
5726         }
5727
5728         protected boolean isMarkingOccurrences() {
5729                 return fMarkOccurrenceAnnotations;
5730         }
5731
5732         void removeOccurrenceAnnotations() {
5733                 fMarkOccurrenceModificationStamp = IDocumentExtension4.UNKNOWN_MODIFICATION_STAMP;
5734                 fMarkOccurrenceTargetRegion = null;
5735
5736                 IDocumentProvider documentProvider = getDocumentProvider();
5737                 if (documentProvider == null)
5738                         return;
5739
5740                 IAnnotationModel annotationModel = documentProvider.getAnnotationModel(getEditorInput());
5741                 if (annotationModel == null || fOccurrenceAnnotations == null)
5742                         return;
5743
5744                 synchronized (getLockObject(annotationModel)) {
5745                         if (annotationModel instanceof IAnnotationModelExtension) {
5746                                 ((IAnnotationModelExtension) annotationModel).replaceAnnotations(fOccurrenceAnnotations, null);
5747                         } else {
5748                                 for (int i = 0, length = fOccurrenceAnnotations.length; i < length; i++)
5749                                         annotationModel.removeAnnotation(fOccurrenceAnnotations[i]);
5750                         }
5751                         fOccurrenceAnnotations = null;
5752                 }
5753         }
5754 }