Addition of previous bugfix. Added project based path to search-path.
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / ProblemPainter.java
index 15cef95..d02d7cb 100644 (file)
@@ -1,17 +1,16 @@
 /**********************************************************************
-Copyright (c) 2000, 2002 IBM Corp. and others.
-All rights reserved. This program and the accompanying materials
-are made available under the terms of the Common Public License v1.0
-which accompanies this distribution, and is available at
-http://www.eclipse.org/legal/cpl-v10.html
+ Copyright (c) 2000, 2002 IBM Corp. and others.
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Common Public License v1.0
+ which accompanies this distribution, and is available at
+ http://www.eclipse.org/legal/cpl-v10.html
 
-Contributors:
-    IBM Corporation - Initial implementation
-**********************************************************************/
+ Contributors:
+ IBM Corporation - Initial implementation
+ **********************************************************************/
 
 package net.sourceforge.phpeclipse.phpeditor;
 
-
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -45,33 +44,41 @@ import org.eclipse.ui.texteditor.ITextEditor;
 /**
  * Highlights the temporary problems.
  */
-public class ProblemPainter implements IPainter, PaintListener, IAnnotationModelListener {
+public class ProblemPainter implements IPainter, PaintListener,
+               IAnnotationModelListener {
 
        private static class ProblemPosition {
                Position fPosition;
+
                Color fColor;
+
                boolean fMultiLine;
        };
 
-       private boolean fIsActive= false;
-       private boolean fIsPainting= false;
-       private boolean fIsSettingModel= false;
+       private boolean fIsActive = false;
+
+       private boolean fIsPainting = false;
+
+       private boolean fIsSettingModel = false;
 
        private ITextEditor fTextEditor;
+
        private ISourceViewer fSourceViewer;
+
        private StyledText fTextWidget;
+
        private IAnnotationModel fModel;
-       private List fProblemPositions= new ArrayList();
 
-       private Map fColorTable= new HashMap();
-       private Set fAnnotationSet= new HashSet();
+       private List fProblemPositions = new ArrayList();
 
+       private Map fColorTable = new HashMap();
 
+       private Set fAnnotationSet = new HashSet();
 
        public ProblemPainter(ITextEditor textEditor, ISourceViewer sourceViewer) {
-               fTextEditor= textEditor;
-               fSourceViewer= sourceViewer;
-               fTextWidget= sourceViewer.getTextWidget();
+               fTextEditor = textEditor;
+               fSourceViewer = sourceViewer;
+               fTextWidget = sourceViewer.getTextWidget();
        }
 
        private boolean hasProblems() {
@@ -80,7 +87,7 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
        private void enablePainting() {
                if (!fIsPainting && hasProblems()) {
-                       fIsPainting= true;
+                       fIsPainting = true;
                        fTextWidget.addPaintListener(this);
                        handleDrawRequest(null);
                }
@@ -88,7 +95,7 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
        private void disablePainting(boolean redraw) {
                if (fIsPainting) {
-                       fIsPainting= false;
+                       fIsPainting = false;
                        fTextWidget.removePaintListener(this);
                        if (redraw && hasProblems())
                                handleDrawRequest(null);
@@ -99,13 +106,13 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
                if (fModel != model) {
                        if (fModel != null)
                                fModel.removeAnnotationModelListener(this);
-                       fModel= model;
+                       fModel = model;
                        if (fModel != null) {
                                try {
-                                       fIsSettingModel= true;
+                                       fIsSettingModel = true;
                                        fModel.addAnnotationModelListener(this);
                                } finally {
-                                       fIsSettingModel= false;
+                                       fIsSettingModel = false;
                                }
                        }
                }
@@ -116,21 +123,21 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
                        fProblemPositions.clear();
                        if (fModel != null) {
 
-                               Iterator e= new ProblemAnnotationIterator(fModel, true);
+                               Iterator e = new ProblemAnnotationIterator(fModel, true);
                                while (e.hasNext()) {
-                                       IProblemAnnotation pa= (IProblemAnnotation) e.next();
-                                       Annotation a= (Annotation) pa;
+                                       IProblemAnnotation pa = (IProblemAnnotation) e.next();
+                                       Annotation a = (Annotation) pa;
 
-                                       Color color= null;
-                                       AnnotationType type= pa.getAnnotationType();
+                                       Color color = null;
+                                       AnnotationType type = pa.getAnnotationType();
                                        if (fAnnotationSet.contains(type))
-                                               color= (Color) fColorTable.get(type);
+                                               color = (Color) fColorTable.get(type);
 
                                        if (color != null) {
-                                               ProblemPosition pp= new ProblemPosition();
-                                               pp.fPosition= fModel.getPosition(a);
-                                               pp.fColor= color;
-                                               pp.fMultiLine= true;
+                                               ProblemPosition pp = new ProblemPosition();
+                                               pp.fPosition = fModel.getPosition(a);
+                                               pp.fColor = color;
+                                               pp.fMultiLine = true;
                                                fProblemPositions.add(pp);
                                        }
                                }
@@ -153,11 +160,12 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
                                // inside the ui thread -> no need for posting
                                updatePainting();
                        } else {
-                               Display d= fTextWidget.getDisplay();
+                               Display d = fTextWidget.getDisplay();
                                if (d != null) {
                                        d.asyncExec(new Runnable() {
                                                public void run() {
-                                                       if (fTextWidget != null && !fTextWidget.isDisposed())
+                                                       if (fTextWidget != null
+                                                                       && !fTextWidget.isDisposed())
                                                                updatePainting();
                                                }
                                        });
@@ -191,29 +199,29 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
                if (fColorTable != null)
                        fColorTable.clear();
-               fColorTable= null;
+               fColorTable = null;
 
                if (fAnnotationSet != null)
                        fAnnotationSet.clear();
-               fAnnotationSet= null;
+               fAnnotationSet = null;
 
-               fTextWidget= null;
-               fModel= null;
-               fProblemPositions= null;
+               fTextWidget = null;
+               fModel = null;
+               fProblemPositions = null;
        }
 
        /*
-        * Returns the document offset of the upper left corner of the widgets viewport,
-        * possibly including partially visible lines.
+        * Returns the document offset of the upper left corner of the widgets
+        * viewport, possibly including partially visible lines.
         */
        private int getInclusiveTopIndexStartOffset() {
 
                if (fTextWidget != null && !fTextWidget.isDisposed()) {
-                       int top= fSourceViewer.getTopIndex();
+                       int top = fSourceViewer.getTopIndex();
                        if ((fTextWidget.getTopPixel() % fTextWidget.getLineHeight()) != 0)
                                top--;
                        try {
-                               IDocument document= fSourceViewer.getDocument();
+                               IDocument document = fSourceViewer.getDocument();
                                return document.getLineOffset(top);
                        } catch (BadLocationException ex) {
                        }
@@ -232,39 +240,47 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
        private void handleDrawRequest(GC gc) {
 
-               int vOffset= getInclusiveTopIndexStartOffset();
+               int vOffset = getInclusiveTopIndexStartOffset();
                // http://bugs.eclipse.org/bugs/show_bug.cgi?id=17147
-               int vLength= fSourceViewer.getBottomIndexEndOffset() + 1;
+               int vLength = fSourceViewer.getBottomIndexEndOffset() + 1;
 
                for (Iterator e = fProblemPositions.iterator(); e.hasNext();) {
                        ProblemPosition pp = (ProblemPosition) e.next();
-                       Position p= pp.fPosition;
+                       Position p = pp.fPosition;
                        if (p.overlapsWith(vOffset, vLength)) {
 
                                if (!pp.fMultiLine) {
 
-                                       IRegion widgetRange= getWidgetRange(p);
+                                       IRegion widgetRange = getWidgetRange(p);
                                        if (widgetRange != null)
-                                               draw(gc, widgetRange.getOffset(), widgetRange.getLength(), pp.fColor);
+                                               draw(gc, widgetRange.getOffset(), widgetRange
+                                                               .getLength(), pp.fColor);
 
                                } else {
 
-                                       IDocument document= fSourceViewer.getDocument();
+                                       IDocument document = fSourceViewer.getDocument();
                                        try {
 
-                                               int startLine= document.getLineOfOffset(p.getOffset());
-                                               int lastInclusive= Math.max(p.getOffset(), p.getOffset() + p.getLength() - 1);
-                                               int endLine= document.getLineOfOffset(lastInclusive);
-
-                                               for (int i= startLine; i <= endLine; i++) {
-                                                       IRegion line= document.getLineInformation(i);
-                                                       int paintStart= Math.max(line.getOffset(), p.getOffset());
-                                                       int paintEnd= Math.min(line.getOffset() + line.getLength(), p.getOffset() + p.getLength());
+                                               int startLine = document.getLineOfOffset(p.getOffset());
+                                               int lastInclusive = Math.max(p.getOffset(), p
+                                                               .getOffset()
+                                                               + p.getLength() - 1);
+                                               int endLine = document.getLineOfOffset(lastInclusive);
+
+                                               for (int i = startLine; i <= endLine; i++) {
+                                                       IRegion line = document.getLineInformation(i);
+                                                       int paintStart = Math.max(line.getOffset(), p
+                                                                       .getOffset());
+                                                       int paintEnd = Math.min(line.getOffset()
+                                                                       + line.getLength(), p.getOffset()
+                                                                       + p.getLength());
                                                        if (paintEnd > paintStart) {
                                                                // otherwise inside a line delimiter
-                                                               IRegion widgetRange= getWidgetRange(new Position(paintStart, paintEnd - paintStart));
+                                                               IRegion widgetRange = getWidgetRange(new Position(
+                                                                               paintStart, paintEnd - paintStart));
                                                                if (widgetRange != null)
-                                                                       draw(gc, widgetRange.getOffset(), widgetRange.getLength(), pp.fColor);
+                                                                       draw(gc, widgetRange.getOffset(),
+                                                                                       widgetRange.getLength(), pp.fColor);
                                                        }
                                                }
 
@@ -277,18 +293,20 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
        private IRegion getWidgetRange(Position p) {
                if (fSourceViewer instanceof ITextViewerExtension5) {
-                       ITextViewerExtension5 extension= (ITextViewerExtension5) fSourceViewer;
-                       return extension.modelRange2WidgetRange(new Region(p.getOffset(), p.getLength()));
+                       ITextViewerExtension5 extension = (ITextViewerExtension5) fSourceViewer;
+                       return extension.modelRange2WidgetRange(new Region(p.getOffset(), p
+                                       .getLength()));
 
                } else {
 
-                       IRegion region= fSourceViewer.getVisibleRegion();
-                       int offset= region.getOffset();
-                       int length= region.getLength();
+                       IRegion region = fSourceViewer.getVisibleRegion();
+                       int offset = region.getOffset();
+                       int length = region.getLength();
 
-                       if (p.overlapsWith(offset , length)) {
-                               int p1= Math.max(offset, p.getOffset());
-                               int p2= Math.min(offset + length, p.getOffset() + p.getLength());
+                       if (p.overlapsWith(offset, length)) {
+                               int p1 = Math.max(offset, p.getOffset());
+                               int p2 = Math.min(offset + length, p.getOffset()
+                                               + p.getLength());
                                return new Region(p1 - offset, p2 - p1);
                        }
                }
@@ -298,42 +316,42 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
 
        private int[] computePolyline(Point left, Point right, int height) {
 
-               final int WIDTH= 4; // must be even
-               final int HEIGHT= 2; // can be any number
-//             final int MINPEEKS= 2; // minimal number of peeks
+               final int WIDTH = 4; // must be even
+               final int HEIGHT = 2; // can be any number
+               // final int MINPEEKS= 2; // minimal number of peeks
 
-               int peeks= (right.x - left.x) / WIDTH;
-//             if (peeks < MINPEEKS) {
-//                     int missing= (MINPEEKS - peeks) * WIDTH;
-//                     left.x= Math.max(0, left.x - missing/2);
-//                     peeks= MINPEEKS;
-//             }
+               int peeks = (right.x - left.x) / WIDTH;
+               // if (peeks < MINPEEKS) {
+               // int missing= (MINPEEKS - peeks) * WIDTH;
+               // left.x= Math.max(0, left.x - missing/2);
+               // peeks= MINPEEKS;
+               // }
 
-               int leftX= left.x;
+               int leftX = left.x;
 
                // compute (number of point) * 2
-               int length= ((2 * peeks) + 1) * 2;
+               int length = ((2 * peeks) + 1) * 2;
                if (length < 0)
                        return new int[0];
 
-               int[] coordinates= new int[length];
+               int[] coordinates = new int[length];
 
                // cache peeks' y-coordinates
-               int bottom= left.y + height - 1;
-               int top= bottom - HEIGHT;
+               int bottom = left.y + height - 1;
+               int top = bottom - HEIGHT;
 
                // populate array with peek coordinates
-               for (int i= 0; i < peeks; i++) {
-                       int index= 4 * i;
-                       coordinates[index]= leftX + (WIDTH * i);
-                       coordinates[index+1]= bottom;
-                       coordinates[index+2]= coordinates[index] + WIDTH/2;
-                       coordinates[index+3]= top;
+               for (int i = 0; i < peeks; i++) {
+                       int index = 4 * i;
+                       coordinates[index] = leftX + (WIDTH * i);
+                       coordinates[index + 1] = bottom;
+                       coordinates[index + 2] = coordinates[index] + WIDTH / 2;
+                       coordinates[index + 3] = top;
                }
 
                // the last down flank is missing
-               coordinates[length-2]= left.x + (WIDTH * peeks);
-               coordinates[length-1]= bottom;
+               coordinates[length - 2] = left.x + (WIDTH * peeks);
+               coordinates[length - 1] = bottom;
 
                return coordinates;
        }
@@ -341,11 +359,12 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
        private void draw(GC gc, int offset, int length, Color color) {
                if (gc != null) {
 
-                       Point left= fTextWidget.getLocationAtOffset(offset);
-                       Point right= fTextWidget.getLocationAtOffset(offset + length);
+                       Point left = fTextWidget.getLocationAtOffset(offset);
+                       Point right = fTextWidget.getLocationAtOffset(offset + length);
 
                        gc.setForeground(color);
-                       int[] polyline= computePolyline(left, right, gc.getFontMetrics().getHeight());
+                       int[] polyline = computePolyline(left, right, gc.getFontMetrics()
+                                       .getHeight());
                        gc.drawPolyline(polyline);
 
                } else {
@@ -358,7 +377,7 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
         */
        public void deactivate(boolean redraw) {
                if (fIsActive) {
-                       fIsActive= false;
+                       fIsActive = false;
                        disablePainting(redraw);
                        setModel(null);
                        catchupWithModel();
@@ -370,8 +389,9 @@ public class ProblemPainter implements IPainter, PaintListener, IAnnotationModel
         */
        public void paint(int reason) {
                if (!fIsActive) {
-                       fIsActive= true;
-                       IDocumentProvider provider= PHPeclipsePlugin.getDefault().getCompilationUnitDocumentProvider();
+                       fIsActive = true;
+                       IDocumentProvider provider = PHPeclipsePlugin.getDefault()
+                                       .getCompilationUnitDocumentProvider();
                        setModel(provider.getAnnotationModel(fTextEditor.getEditorInput()));
                } else if (CONFIGURATION == reason || INTERNAL == reason)
                        updatePainting();