Added PHPUnitEditor and corresponding PHPPreferencePage
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / internal / ui / text / link / LinkedPositionUI.java
index be32c18..d02d674 100644 (file)
@@ -6,6 +6,8 @@ package net.sourceforge.phpdt.internal.ui.text.link;
 
 import java.lang.reflect.InvocationTargetException;
 
+import net.sourceforge.phpdt.internal.ui.util.ExceptionHandler;
+import net.sourceforge.phpdt.ui.PreferenceConstants;
 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
 
 import org.eclipse.core.runtime.CoreException;
@@ -19,10 +21,14 @@ import org.eclipse.jface.text.IDocument;
 import org.eclipse.jface.text.IPositionUpdater;
 import org.eclipse.jface.text.IRegion;
 import org.eclipse.jface.text.ITextInputListener;
+import org.eclipse.jface.text.ITextListener;
 import org.eclipse.jface.text.ITextViewer;
 import org.eclipse.jface.text.ITextViewerExtension;
+import org.eclipse.jface.text.ITextViewerExtension2;
+import org.eclipse.jface.text.ITextViewerExtension3;
 import org.eclipse.jface.text.Position;
 import org.eclipse.jface.text.Region;
+import org.eclipse.jface.text.TextEvent;
 import org.eclipse.jface.util.Assert;
 import org.eclipse.jface.util.IPropertyChangeListener;
 import org.eclipse.jface.util.PropertyChangeEvent;
@@ -33,6 +39,8 @@ import org.eclipse.swt.events.ModifyEvent;
 import org.eclipse.swt.events.ModifyListener;
 import org.eclipse.swt.events.PaintEvent;
 import org.eclipse.swt.events.PaintListener;
+import org.eclipse.swt.events.ShellEvent;
+import org.eclipse.swt.events.ShellListener;
 import org.eclipse.swt.events.VerifyEvent;
 import org.eclipse.swt.events.VerifyListener;
 import org.eclipse.swt.graphics.Color;
@@ -46,7 +54,7 @@ import org.eclipse.swt.widgets.Shell;
  * A user interface for <code>LinkedPositionManager</code>, using <code>ITextViewer</code>.
  */
 public class LinkedPositionUI implements LinkedPositionListener,
-       ITextInputListener, ModifyListener, VerifyListener, VerifyKeyListener, PaintListener, IPropertyChangeListener {
+       ITextInputListener, ITextListener, ModifyListener, VerifyListener, VerifyKeyListener, PaintListener, IPropertyChangeListener, ShellListener {
 
        /**
         * A listener for notification when the user cancelled the edit operation.
@@ -55,13 +63,24 @@ public class LinkedPositionUI implements LinkedPositionListener,
                void exit(boolean accept);
        }
        
-  /** Preference key for linked position color */
- // public final static String LINKED_POSITION_COLOR= "_linkedPositionColor"; //$NON-NLS-1$
+       public static class ExitFlags {
+               public int flags;       
+               public boolean doit;
+               public ExitFlags(int flags, boolean doit) {
+                       this.flags= flags;
+                       this.doit= doit;
+               }                                               
+       }
+       
+       public interface ExitPolicy {
+               ExitFlags doExit(LinkedPositionManager manager, VerifyEvent event, int offset, int length);
+       }
+       
        // leave flags
        private static final int UNINSTALL= 1;                  // uninstall linked position manager
-       private static final int COMMIT= 2;                             // commit changes
+       public static final int COMMIT= 2;                              // commit changes
        private static final int DOCUMENT_CHANGED= 4;   // document has changed
-       private static final int UPDATE_CARET= 8;               // update caret
+       public static final int UPDATE_CARET= 8;                // update caret
 
        private static final String CARET_POSITION= "LinkedPositionUI.caret.position"; //$NON-NLS-1$
        private static final IPositionUpdater fgUpdater= new DefaultPositionUpdater(CARET_POSITION);
@@ -74,10 +93,16 @@ public class LinkedPositionUI implements LinkedPositionListener,
        private int fFinalCaretOffset= -1; // no final caret offset
 
        private Position fFramePosition;
+       private int fInitialOffset= -1;
        private int fCaretOffset;
        
+       private ExitPolicy fExitPolicy;
        private ExitListener fExitListener;
        
+       private boolean fNeedRedraw;
+       
+       private String fContentType;
+
        /**
         * Creates a user interface for <code>LinkedPositionManager</code>.
         * 
@@ -100,8 +125,7 @@ public class LinkedPositionUI implements LinkedPositionListener,
         * @see IPropertyChangeListener#propertyChange(PropertyChangeEvent)
         */
        public void propertyChange(PropertyChangeEvent event) {
-       //      if (event.getProperty().equals(CompilationUnitEditor.LINKED_POSITION_COLOR)) {
-    if (event.getProperty().equals(PHPeclipsePlugin.LINKED_POSITION_COLOR)) {
+               if (event.getProperty().equals(PreferenceConstants.EDITOR_LINKED_POSITION_COLOR)) {
                        initializeHighlightColor(fViewer);
                        redrawRegion();
                }
@@ -115,9 +139,8 @@ public class LinkedPositionUI implements LinkedPositionListener,
                StyledText text= viewer.getTextWidget();
                if (text != null) {
                        Display display= text.getDisplay();
-       //              fFrameColor= createColor(fgStore, CompilationUnitEditor.LINKED_POSITION_COLOR, display);
-                 fFrameColor= createColor(fgStore, PHPeclipsePlugin.LINKED_POSITION_COLOR, display);
-    }
+                       fFrameColor= createColor(fgStore, PreferenceConstants.EDITOR_LINKED_POSITION_COLOR, display);
+               }
        }
 
        /**
@@ -141,6 +164,14 @@ public class LinkedPositionUI implements LinkedPositionListener,
                
                return null;
        }
+
+       /**
+        * Sets the initial offset.
+        * @param offset
+        */
+       public void setInitialOffset(int offset) {
+               fInitialOffset= offset; 
+       }
        
        /**
         * Sets the final position of the caret when the linked mode is exited
@@ -158,12 +189,20 @@ public class LinkedPositionUI implements LinkedPositionListener,
                fExitListener= listener;
        }
 
+       /**
+        * Sets an <code>ExitPolicy</code> which decides when and how
+        * the linked mode is exited.
+        */
+       public void setExitPolicy(ExitPolicy policy) {
+               fExitPolicy= policy;
+       }
+
        /*
         * @see LinkedPositionManager.LinkedPositionListener#setCurrentPositions(Position, int)
         */
        public void setCurrentPosition(Position position, int caretOffset) {
                if (!fFramePosition.equals(position)) {
-                       redrawRegion();
+                       fNeedRedraw= true;
                        fFramePosition= position;
                }
 
@@ -177,10 +216,12 @@ public class LinkedPositionUI implements LinkedPositionListener,
         * @see #exit(boolean)
         */
        public void enter() {
+
                // track final caret
                IDocument document= fViewer.getDocument();
                document.addPositionCategory(CARET_POSITION);
                document.addPositionUpdater(fgUpdater);
+
                try {
                        if (fFinalCaretOffset != -1)
                                document.addPosition(CARET_POSITION, new Position(fFinalCaretOffset));
@@ -188,11 +229,12 @@ public class LinkedPositionUI implements LinkedPositionListener,
                        handleException(fViewer.getTextWidget().getShell(), e);
 
                } catch (BadPositionCategoryException e) {
-                       PHPeclipsePlugin.log(e);
+      PHPeclipsePlugin.log(e);
                        Assert.isTrue(false);
                }
 
                fViewer.addTextInputListener(this);
+               fViewer.addTextListener(this);
                                
                ITextViewerExtension extension= (ITextViewerExtension) fViewer;
                extension.prependVerifyKeyListener(this);
@@ -203,11 +245,28 @@ public class LinkedPositionUI implements LinkedPositionListener,
                text.addPaintListener(this);
                text.showSelection();
 
-               fFramePosition= fManager.getFirstPosition();
-               if (fFramePosition == null)
+               Shell shell= text.getShell();
+               shell.addShellListener(this);
+
+               fFramePosition= (fInitialOffset == -1) ? fManager.getFirstPosition() : fManager.getPosition(fInitialOffset);
+               if (fFramePosition == null) {
                        leave(UNINSTALL | COMMIT | UPDATE_CARET);
+                       return;
+               }
 
                fgStore.addPropertyChangeListener(this);
+
+               try {
+                       fContentType= document.getContentType(fFramePosition.offset);
+                       if (fViewer instanceof ITextViewerExtension2) {
+                               ((ITextViewerExtension2) fViewer).prependAutoEditStrategy(fManager, fContentType);
+                       } else {
+                               Assert.isTrue(false);
+                       }
+
+               } catch (BadLocationException e) {
+                       handleException(fViewer.getTextWidget().getShell(), e);
+               }
        }
 
        /*
@@ -230,6 +289,9 @@ public class LinkedPositionUI implements LinkedPositionListener,
        }
        
        private void leave(int flags) {
+
+               fInitialOffset= -1;
+               
                if ((flags & UNINSTALL) != 0)
                        fManager.uninstall((flags & COMMIT) != 0);
 
@@ -245,13 +307,20 @@ public class LinkedPositionUI implements LinkedPositionListener,
                text.removeModifyListener(this);
                text.removeVerifyListener(this);
 
+               Shell shell= text.getShell();
+               shell.removeShellListener(this);
+
                ITextViewerExtension extension= (ITextViewerExtension) fViewer;
                extension.removeVerifyKeyListener(this);
 
+               if (fViewer instanceof ITextViewerExtension2 && fContentType != null)
+                       ((ITextViewerExtension2) fViewer).removeAutoEditStrategy(fManager, fContentType);
+               fContentType= null;
+
+               fViewer.removeTextListener(this);
                fViewer.removeTextInputListener(this);
                
                try {
-                       IRegion region= fViewer.getVisibleRegion();
                        IDocument document= fViewer.getDocument();
 
                        if (((flags & COMMIT) != 0) &&
@@ -259,11 +328,20 @@ public class LinkedPositionUI implements LinkedPositionListener,
                                ((flags & UPDATE_CARET) != 0))
                        {
                                Position[] positions= document.getPositions(CARET_POSITION);
-
                                if ((positions != null) && (positions.length != 0)) {
-                                       int offset= positions[0].getOffset() - region.getOffset();              
-                                       if ((offset >= 0) && (offset <= region.getLength()))
-                                               text.setSelection(offset, offset);
+                                       
+                                       if (fViewer instanceof ITextViewerExtension3) {
+                                               ITextViewerExtension3 extension3= (ITextViewerExtension3) fViewer;
+                                               int widgetOffset= extension3.modelOffset2WidgetOffset(positions[0].getOffset());
+                                               if (widgetOffset >= 0)
+                                                       text.setSelection(widgetOffset, widgetOffset);
+                                                       
+                                       } else {
+                                               IRegion region= fViewer.getVisibleRegion();
+                                               int offset= positions[0].getOffset() - region.getOffset();
+                                               if ((offset >= 0) && (offset <= region.getLength()))
+                                                       text.setSelection(offset, offset);
+                                       }
                                }
                        }
 
@@ -276,7 +354,7 @@ public class LinkedPositionUI implements LinkedPositionListener,
                                        ((flags & DOCUMENT_CHANGED) != 0));
 
                } catch (BadPositionCategoryException e) {
-                       PHPeclipsePlugin.log(e);
+      PHPeclipsePlugin.log(e);
                        Assert.isTrue(false);
                }
 
@@ -306,25 +384,35 @@ public class LinkedPositionUI implements LinkedPositionListener,
                        fFramePosition= position;
                        selectRegion();
                        redrawRegion();
-               }                               
+               }
        }
 
        /*
         * @see VerifyKeyListener#verifyKey(VerifyEvent)
         */
        public void verifyKey(VerifyEvent event) {
+
+               if (!event.doit)
+                       return;
+               
+               Point selection= fViewer.getSelectedRange();
+               int offset= selection.x;
+               int length= selection.y;
+               
+               ExitFlags exitFlags= fExitPolicy == null ? null : fExitPolicy.doExit(fManager, event, offset, length);
+               if (exitFlags != null) {
+                       leave(UNINSTALL | exitFlags.flags);
+                       event.doit= exitFlags.doit;
+                       return;
+               }
+               
                switch (event.character) {
                // [SHIFT-]TAB = hop between edit boxes
                case 0x09:
                        {
-                               Point selection= fViewer.getTextWidget().getSelection();
-                               IRegion region= fViewer.getVisibleRegion();
-                               int offset= selection.x + region.getOffset();
-                               int length= selection.y - selection.x;
-                               
                                // if tab was treated as a document change, would it exceed variable range?
                                if (!LinkedPositionManager.includes(fFramePosition, offset, length)) {
-                                       leave(UNINSTALL | COMMIT | UPDATE_CARET);
+                                       leave(UNINSTALL | COMMIT);
                                        return;
                                }
                        }
@@ -358,11 +446,25 @@ public class LinkedPositionUI implements LinkedPositionListener,
                if (!event.doit)
                        return;
 
-               IRegion region= fViewer.getVisibleRegion();
-
-               int offset= event.start + region.getOffset();
-               int length= event.end - event.start;
 
+               int offset= 0;
+               int length= 0;
+               
+               if (fViewer instanceof ITextViewerExtension3) {
+                       ITextViewerExtension3 extension= (ITextViewerExtension3) fViewer;
+                       IRegion modelRange= extension.widgetRange2ModelRange(new Region(event.start, event.end - event.start));
+                       if (modelRange == null)
+                               return;
+                               
+                       offset= modelRange.getOffset();
+                       length= modelRange.getLength();
+                               
+               } else {
+                       IRegion visibleRegion= fViewer.getVisibleRegion();
+                       offset= event.start + visibleRegion.getOffset();
+                       length= event.end - event.start;
+               }
+               
                // allow changes only within linked positions when coming through UI
                if (!fManager.anyPositionIncludes(offset, length))
                        leave(UNINSTALL | COMMIT);
@@ -374,18 +476,16 @@ public class LinkedPositionUI implements LinkedPositionListener,
        public void paintControl(PaintEvent event) {    
                if (fFramePosition == null)
                        return;
-
-               IRegion region= fViewer.getVisibleRegion();
-               
-               // #6824
-               if (!includes(region, fFramePosition)) {
-                       leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
-                       return;             
-               }
-               
-               int offset= fFramePosition.getOffset() -  region.getOffset();
-               int length= fFramePosition.getLength();
                        
+               IRegion widgetRange= asWidgetRange(fFramePosition);
+               if (widgetRange == null) {
+                       leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
+                       return;
+               }
+
+               int offset= widgetRange.getOffset();
+               int length= widgetRange.getLength();
+
                StyledText text= fViewer.getTextWidget();
                
                // support for bidi
@@ -400,6 +500,22 @@ public class LinkedPositionUI implements LinkedPositionListener,
                gc.setForeground(fFrameColor);
                gc.drawLine(x1, y, x2, y);
        }
+       
+       protected IRegion asWidgetRange(Position position) {
+               if (fViewer instanceof ITextViewerExtension3) {
+                       
+                       ITextViewerExtension3 extension= (ITextViewerExtension3) fViewer;
+                       return extension.modelRange2WidgetRange(new Region(position.getOffset(), position.getLength()));
+               
+               } else {
+                       
+                       IRegion region= fViewer.getVisibleRegion();
+                       if (includes(region, position))
+                               return new Region(position.getOffset() -  region.getOffset(), position.getLength());
+               }
+               
+               return null;
+       }
 
        private static Point getMinimumLocation(StyledText text, int offset, int length) {
                Point minLocation= new Point(Integer.MAX_VALUE, Integer.MAX_VALUE);
@@ -432,52 +548,45 @@ public class LinkedPositionUI implements LinkedPositionListener,
        }
 
        private void redrawRegion() {
-               IRegion region= fViewer.getVisibleRegion();
-               
-               if (!includes(region, fFramePosition)) {
+               IRegion widgetRange= asWidgetRange(fFramePosition);
+               if (widgetRange == null) {
                        leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
                        return;             
                }
-
-               int offset= fFramePosition.getOffset() -  region.getOffset();
-               int length= fFramePosition.getLength();
-
+               
                StyledText text= fViewer.getTextWidget();
-               if (text != null && !text.isDisposed())
-                       text.redrawRange(offset, length, true);
+               if (text != null && !text.isDisposed()) 
+                       text.redrawRange(widgetRange.getOffset(), widgetRange.getLength(), true);
        }
 
        private void selectRegion() {
-               IRegion region= fViewer.getVisibleRegion();
-
-               if (!includes(region, fFramePosition)) {
+               
+               IRegion widgetRange= asWidgetRange(fFramePosition);
+               if (widgetRange == null) {
                        leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
                        return;   
                }
 
-               int start= fFramePosition.getOffset() - region.getOffset();
-               int end= fFramePosition.getLength() + start;    
-
                StyledText text= fViewer.getTextWidget();
-               if (text != null && !text.isDisposed())
+               if (text != null && !text.isDisposed()) {
+                       int start= widgetRange.getOffset();
+                       int end= widgetRange.getLength() + start;
                        text.setSelection(start, end);
+               }
        }
-
+       
        private void updateCaret() {
-               IRegion region= fViewer.getVisibleRegion();             
-
-               if (!includes(region, fFramePosition)) {
+               
+               IRegion widgetRange= asWidgetRange(fFramePosition);
+               if (widgetRange == null) {
                        leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
                        return;   
                }
-
-               int offset= fFramePosition.getOffset() + fCaretOffset - region.getOffset();
                
-               if ((offset >= 0) && (offset <= region.getLength())) {
-                       StyledText text= fViewer.getTextWidget();
-                       if (text != null && !text.isDisposed())
-                               text.setCaretOffset(offset);
-               }
+               int offset= widgetRange.getOffset() + fCaretOffset;
+               StyledText text= fViewer.getTextWidget();
+               if (text != null && !text.isDisposed())
+                       text.setCaretOffset(offset);
        }
 
        /*
@@ -492,14 +601,12 @@ public class LinkedPositionUI implements LinkedPositionListener,
        private static void handleException(Shell shell, Exception e) {
                String title= LinkedPositionMessages.getString("LinkedPositionUI.error.title"); //$NON-NLS-1$
                if (e instanceof CoreException)
-                       PHPeclipsePlugin.log(e);
-   //   ExceptionHandler.handle((CoreException)e, shell, title, null);
+                       ExceptionHandler.handle((CoreException)e, shell, title, null);
                else if (e instanceof InvocationTargetException)
-                       PHPeclipsePlugin.log(e);
-    //  ExceptionHandler.handle((InvocationTargetException)e, shell, title, null);
+                       ExceptionHandler.handle((InvocationTargetException)e, shell, title, null);
                else {
                        MessageDialog.openError(shell, title, e.getMessage());
-                       PHPeclipsePlugin.log(e);
+      PHPeclipsePlugin.log(e);
                }
        }
 
@@ -524,4 +631,48 @@ public class LinkedPositionUI implements LinkedPositionListener,
                        position.getOffset() + position.getLength() <= region.getOffset() + region.getLength();
        }
 
+       /*
+        * @see org.eclipse.jface.text.ITextListener#textChanged(TextEvent)
+        */
+       public void textChanged(TextEvent event) {
+               if (!fNeedRedraw)
+                       return;
+                       
+               redrawRegion();
+               fNeedRedraw= false;
+       }
+
+       /*
+        * @see org.eclipse.swt.events.ShellListener#shellActivated(org.eclipse.swt.events.ShellEvent)
+        */
+       public void shellActivated(ShellEvent event) {
+       }
+
+       /*
+        * @see org.eclipse.swt.events.ShellListener#shellClosed(org.eclipse.swt.events.ShellEvent)
+        */
+       public void shellClosed(ShellEvent event) {
+               leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
+       }
+
+       /*
+        * @see org.eclipse.swt.events.ShellListener#shellDeactivated(org.eclipse.swt.events.ShellEvent)
+        */
+       public void shellDeactivated(ShellEvent event) {
+               leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
+       }
+
+       /*
+        * @see org.eclipse.swt.events.ShellListener#shellDeiconified(org.eclipse.swt.events.ShellEvent)
+        */
+       public void shellDeiconified(ShellEvent event) {
+       }
+
+       /*
+        * @see org.eclipse.swt.events.ShellListener#shellIconified(org.eclipse.swt.events.ShellEvent)
+        */
+       public void shellIconified(ShellEvent event) {
+               leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
+       }
+
 }
\ No newline at end of file