net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/ui/viewsupport/ProblemMarkerManager.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.internal.ui.viewsupport;
  12
  13
  14 import java.util.HashSet;
  15
  16 import net.sourceforge.phpdt.internal.ui.util.SWTUtil;
  17 import net.sourceforge.phpeclipse.PHPeclipsePlugin;
  18 import net.sourceforge.phpeclipse.phpeditor.CompilationUnitAnnotationModelEvent;
  19
  20 import org.eclipse.core.resources.IMarker;
  21 import org.eclipse.core.resources.IMarkerDelta;
  22 import org.eclipse.core.resources.IProject;
  23 import org.eclipse.core.resources.IResource;
  24 import org.eclipse.core.resources.IResourceChangeEvent;
  25 import org.eclipse.core.resources.IResourceChangeListener;
  26 import org.eclipse.core.resources.IResourceDelta;
  27 import org.eclipse.core.resources.IResourceDeltaVisitor;
  28 import org.eclipse.core.runtime.CoreException;
  29 import org.eclipse.jface.text.source.AnnotationModelEvent;
  30 import org.eclipse.jface.text.source.IAnnotationModel;
  31 import org.eclipse.jface.text.source.IAnnotationModelListener;
  32 import org.eclipse.jface.text.source.IAnnotationModelListenerExtension;
  33 import org.eclipse.jface.util.ListenerList;
  34 import org.eclipse.swt.widgets.Display;
  35
  36
  37
  38 /**
  39  * Listens to resource deltas and filters for marker changes of type IMarker.PROBLEM
  40  * Viewers showing error ticks should register as listener to
  41  * this type.
  42  */
  43 public class ProblemMarkerManager implements IResourceChangeListener, IAnnotationModelListener , IAnnotationModelListenerExtension {
  44
  45         /**
  46          * Visitors used to look if the element change delta containes a marker change.
  47          */
  48         private static class ProjectErrorVisitor implements IResourceDeltaVisitor {
  49
  50                 private HashSet fChangedElements;
  51
  52                 public ProjectErrorVisitor(HashSet changedElements) {
  53                         fChangedElements= changedElements;
  54                 }
  55
  56                 public boolean visit(IResourceDelta delta) throws CoreException {
  57                         IResource res= delta.getResource();
  58                         if (res instanceof IProject && delta.getKind() == IResourceDelta.CHANGED) {
  59                                 try {
  60                                         IProject project= (IProject) res;
  61                                         if (!project.isAccessible() || !project.hasNature(PHPeclipsePlugin.PHP_NATURE_ID)) {
  62                                                 // only track open Java projects
  63                                                 return false;
  64                                         }
  65                                 } catch (CoreException e) {
  66                                         PHPeclipsePlugin.log(e);
  67                                         return false;
  68                                 }
  69                         }
  70                         checkInvalidate(delta, res);
  71                         return true;
  72                 }
  73
  74                 private void checkInvalidate(IResourceDelta delta, IResource resource) {
  75                         int kind= delta.getKind();
  76                         if (kind == IResourceDelta.REMOVED || kind == IResourceDelta.ADDED || (kind == IResourceDelta.CHANGED && isErrorDelta(delta))) {
  77                                 // invalidate the resource and all parents
  78                                 while (resource.getType() != IResource.ROOT && fChangedElements.add(resource)) {
  79                                         resource= resource.getParent();
  80                                 }
  81                         }
  82                 }
  83
  84                 private boolean isErrorDelta(IResourceDelta delta) {
  85                         if ((delta.getFlags() & IResourceDelta.MARKERS) != 0) {
  86                                 IMarkerDelta[] markerDeltas= delta.getMarkerDeltas();
  87                                 for (int i= 0; i < markerDeltas.length; i++) {
  88                                         if (markerDeltas[i].isSubtypeOf(IMarker.PROBLEM)) {
  89                                                 int kind= markerDeltas[i].getKind();
  90                                                 if (kind == IResourceDelta.ADDED || kind == IResourceDelta.REMOVED)
  91                                                         return true;
  92                                                 int severity= markerDeltas[i].getAttribute(IMarker.SEVERITY, -1);
  93                                                 int newSeverity= markerDeltas[i].getMarker().getAttribute(IMarker.SEVERITY, -1);
  94                                                 if (newSeverity != severity)
  95                                                         return true;
  96                                         }
  97                                 }
  98                         }
  99                         return false;
 100                 }
 101         }
 102
 103         private ListenerList fListeners;
 104
 105
 106         public ProblemMarkerManager() {
 107                 fListeners= new ListenerList(10);
 108         }
 109
 110         /*
 111          * @see IResourceChangeListener#resourceChanged
 112          */
 113         public void resourceChanged(IResourceChangeEvent event) {
 114                 HashSet changedElements= new HashSet();
 115
 116                 try {
 117                         IResourceDelta delta= event.getDelta();
 118                         if (delta != null)
 119                                 delta.accept(new ProjectErrorVisitor(changedElements));
 120                 } catch (CoreException e) {
 121                         PHPeclipsePlugin.log(e.getStatus());
 122                 }
 123
 124                 if (!changedElements.isEmpty()) {
 125                         IResource[] changes= (IResource[]) changedElements.toArray(new IResource[changedElements.size()]);
 126                         fireChanges(changes, true);
 127                 }
 128         }
 129         /* (non-Javadoc)
 130          * @see IAnnotationModelListener#modelChanged(IAnnotationModel)
 131          */
 132         public void modelChanged(IAnnotationModel model) {
 133                 // no action
 134         }
 135
 136         /* (non-Javadoc)
 137          * @see IAnnotationModelListenerExtension#modelChanged(AnnotationModelEvent)
 138          */
 139         public void modelChanged(AnnotationModelEvent event) {
 140                 if (event instanceof CompilationUnitAnnotationModelEvent) {
 141                         CompilationUnitAnnotationModelEvent cuEvent= (CompilationUnitAnnotationModelEvent) event;
 142                         if (cuEvent.includesProblemMarkerAnnotationChanges()) {
 143                                 IResource[] changes= new IResource[] { cuEvent.getUnderlyingResource() };
 144                                 fireChanges(changes, false);
 145                         }
 146                 }
 147         }
 148
 149         /**
 150          * Adds a listener for problem marker changes.
 151          */
 152         public void addListener(IProblemChangedListener listener) {
 153                 if (fListeners.isEmpty()) {
 154                         PHPeclipsePlugin.getWorkspace().addResourceChangeListener(this);
 155                         PHPeclipsePlugin.getDefault().getCompilationUnitDocumentProvider().addGlobalAnnotationModelListener(this);
 156                 }
 157                 fListeners.add(listener);
 158         }
 159
 160         /**
 161          * Removes a <code>IProblemChangedListener</code>.
 162          */
 163         public void removeListener(IProblemChangedListener listener) {
 164                 fListeners.remove(listener);
 165                 if (fListeners.isEmpty()) {
 166                         PHPeclipsePlugin.getWorkspace().removeResourceChangeListener(this);
 167                         PHPeclipsePlugin.getDefault().getCompilationUnitDocumentProvider().removeGlobalAnnotationModelListener(this);
 168                 }
 169         }
 170
 171         private void fireChanges(final IResource[] changes, final boolean isMarkerChange) {
 172                 Display display= SWTUtil.getStandardDisplay();
 173                 if (display != null && !display.isDisposed()) {
 174                         display.asyncExec(new Runnable() {
 175                                 public void run() {
 176                                         Object[] listeners= fListeners.getListeners();
 177                                         for (int i= 0; i < listeners.length; i++) {
 178                                                 IProblemChangedListener curr= (IProblemChangedListener) listeners[i];
 179                                                 curr.problemsChanged(changes, isMarkerChange);
 180                                         }
 181                                 }
 182                         });
 183                 }
 184         }
 185
 186 }