Merge branch 'pr-98'

Author: adangel

ReleaseNotes.md

@@ -13,6 +13,7 @@ This is a bugfix release.
 
 ### Fixed Issues
 
+*   [#85](https://github.com/pmd/pmd-eclipse-plugin/issues/85): Gutter Markers not Configured Color
 *   [#96](https://github.com/pmd/pmd-eclipse-plugin/issues/96): Wrong auxclasspath if project is stored outside of workspace
 
 ## 31-March-2019: 4.2.0.v20190331-1136

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/plugin/PMDPlugin.java

@@ -81,6 +81,7 @@
 import net.sourceforge.pmd.eclipse.ui.ShapePainter;
 import net.sourceforge.pmd.eclipse.ui.nls.StringKeys;
 import net.sourceforge.pmd.eclipse.ui.nls.StringTable;
+import net.sourceforge.pmd.eclipse.ui.priority.PriorityDescriptorCache;
 import net.sourceforge.pmd.eclipse.util.ResourceManager;
 import net.sourceforge.pmd.lang.LanguageRegistry;
 import net.sourceforge.pmd.lang.LanguageVersion;
@@ -330,8 +331,8 @@ public static IViewPart getView(String id) {
      *  
      * @param viewId id of the view 
      */ 
-    public void refreshView(final String viewId) { 
-        Display.getDefault().asyncExec(new Runnable() { 
+    public void refreshView(final String viewId) {
+        Display.getCurrent().asyncExec(new Runnable() {
             @Override 
             public void run() { 
                 try { 
@@ -371,6 +372,7 @@ public void stop(BundleContext context) throws Exception {
         disposeResources();
         ShapePainter.disposeAll();
         ResourceManager.dispose();
+        PriorityDescriptorCache.INSTANCE.dispose();
         super.stop(context);
     }
 
@@ -734,5 +736,4 @@ public void removedMarkersIn(IResource resource) {
 
         decorator.changed(changes);
     }
-
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/plugin/UISettings.java

@@ -4,8 +4,6 @@
 
 package net.sourceforge.pmd.eclipse.plugin;
 
-import java.net.MalformedURLException;
-import java.net.URL;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Comparator;
@@ -23,7 +21,6 @@
 import org.eclipse.swt.widgets.Display;
 
 import net.sourceforge.pmd.RulePriority;
-import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences;
 import net.sourceforge.pmd.eclipse.runtime.preferences.IPreferencesManager;
 import net.sourceforge.pmd.eclipse.ui.Shape;
 import net.sourceforge.pmd.eclipse.ui.ShapeDescriptor;
@@ -45,32 +42,16 @@ private UISettings() {
 
     private static String[] priorityLabels;
 
-    private static Map<Object, ShapeDescriptor> shapesByPriority;
-    private static Map<Integer, RulePriority> prioritiesByIntValue;
     private static Map<RulePriority, String> labelsByPriority = new HashMap<RulePriority, String>();
 
     private static final int MAX_MARKER_DIMENSION = 9;
     private static IPreferencesManager preferencesManager = PMDPlugin.getDefault().getPreferencesManager();
-    private static final Map<RulePriority, PriorityDescriptor> UI_DESCRIPTORS_BY_PRIORITY = new HashMap<RulePriority, PriorityDescriptor>(
-            5);
 
     public static final FontBuilder CODE_FONT_BUILDER = new FontBuilder("Courier", 11, SWT.NORMAL);
 
+    @Deprecated
     public static void reloadPriorities() {
-        UI_DESCRIPTORS_BY_PRIORITY.clear();
-        uiDescriptorsByPriority(); // cause a reload
-    }
-
-    private static Map<RulePriority, PriorityDescriptor> uiDescriptorsByPriority() {
-
-        if (UI_DESCRIPTORS_BY_PRIORITY.isEmpty()) {
-            IPreferences preferences = preferencesManager.loadPreferences();
-            for (RulePriority rp : currentPriorities(true)) {
-                UI_DESCRIPTORS_BY_PRIORITY.put(rp, preferences.getPriorityDescriptor(rp));
-            }
-        }
-
-        return UI_DESCRIPTORS_BY_PRIORITY;
+        // no-op - nothing to be done anymore. The priority descriptor are cached by PriorityDescriptorCache and not here.
     }
 
     public static Shape[] allShapes() {
@@ -103,34 +84,37 @@ public static Map<Shape, ShapeDescriptor> shapeSet(RGB color, int size) {
         return shapes;
     }
 
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static String markerFilenameFor(RulePriority priority) {
         String fileDir = PMDPlugin.getPluginFolder().getAbsolutePath();
         return fileDir + "/" + relativeMarkerFilenameFor(priority);
     }
 
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static String relativeMarkerFilenameFor(RulePriority priority) {
         return "icons/markerP" + priority.getPriority() + ".png";
     }
 
-    private static ImageDescriptor getImageDescriptor(final String fileName) {
-
-        URL installURL = PMDPlugin.getDefault().getBundle().getEntry("/");
-        try {
-            URL url = new URL(installURL, fileName);
-            return ImageDescriptor.createFromURL(url);
-        } catch (MalformedURLException mue) {
-            mue.printStackTrace();
-            return null;
-        }
-    }
-
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static ImageDescriptor markerDescriptorFor(RulePriority priority) {
-        String path = relativeMarkerFilenameFor(priority);
-        return getImageDescriptor(path);
+        PriorityDescriptor pd = PriorityDescriptorCache.INSTANCE.descriptorFor(priority);
+        return pd.getAnnotationImageDescriptor();
     }
 
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static Map<Integer, ImageDescriptor> markerImgDescriptorsByPriority() {
-
         RulePriority[] priorities = currentPriorities(true);
         Map<Integer, ImageDescriptor> overlaysByPriority = new HashMap<Integer, ImageDescriptor>(priorities.length);
         for (RulePriority priority : priorities) {
@@ -139,19 +123,22 @@ public static Map<Integer, ImageDescriptor> markerImgDescriptorsByPriority() {
         return overlaysByPriority;
     }
 
+    /**
+     * Marker Icons are not stored to files anymore. They are generated on the fly and cached by {@link PriorityDescriptorCache}.
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static void createRuleMarkerIcons(Display display) {
-
         ImageLoader loader = new ImageLoader();
 
         PriorityDescriptorCache pdc = PriorityDescriptorCache.INSTANCE;
 
         for (RulePriority priority : currentPriorities(true)) {
-            Image image = pdc.descriptorFor(priority).getImage(display, MAX_MARKER_DIMENSION);
+            Image image = pdc.descriptorFor(priority).getAnnotationImage();
             loader.data = new ImageData[] { image.getImageData() };
             String fullPath = markerFilenameFor(priority);
             PMDPlugin.getDefault().logInformation("Writing marker icon to: " + fullPath);
             loader.save(fullPath, SWT.IMAGE_PNG);
-
             image.dispose();
         }
     }
@@ -175,12 +162,20 @@ public static void useCustomPriorityLabels(boolean flag) {
         }
     }
 
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor#description}.
+     */
+    @Deprecated
     public static String descriptionFor(RulePriority priority) {
         return descriptorFor(priority).description;
     }
 
+    /**
+     * @deprecated Use {@link PriorityDescriptorCache#descriptorFor(RulePriority)} to retrieve the {@link PriorityDescriptor}.
+     */
+    @Deprecated
     public static PriorityDescriptor descriptorFor(RulePriority priority) {
-        return uiDescriptorsByPriority().get(priority);
+        return PriorityDescriptorCache.INSTANCE.descriptorFor(priority);
     }
 
     public static String labelFor(RulePriority priority) {
@@ -191,36 +186,27 @@ public static String labelFor(RulePriority priority) {
     }
 
     public static Map<Object, ShapeDescriptor> shapesByPriority() {
-
-        if (shapesByPriority != null) {
-            return shapesByPriority;
-        }
-
-        Map<Object, ShapeDescriptor> shapesByPriority = new HashMap<Object, ShapeDescriptor>(
-                uiDescriptorsByPriority().size());
-        for (Map.Entry<RulePriority, PriorityDescriptor> entry : uiDescriptorsByPriority().entrySet()) {
-            shapesByPriority.put(entry.getKey(), entry.getValue().shape);
+        Map<Object, ShapeDescriptor> shapesByPriority = new HashMap<Object, ShapeDescriptor>(RulePriority.values().length);
+        for (RulePriority priority : RulePriority.values()) {
+            shapesByPriority.put(priority, PriorityDescriptorCache.INSTANCE.descriptorFor(priority).shape);
         }
-
         return shapesByPriority;
     }
 
+    /**
+     * @deprecated Use {@link RulePriority#valueOf(int)} directly.
+     */
+    @Deprecated
     public static RulePriority priorityFor(int value) {
-
-        if (prioritiesByIntValue == null) {
-            prioritiesByIntValue = new HashMap<Integer, RulePriority>(uiDescriptorsByPriority().size());
-            for (Map.Entry<RulePriority, PriorityDescriptor> entry : uiDescriptorsByPriority().entrySet()) {
-                prioritiesByIntValue.put(entry.getKey().getPriority(), entry.getKey());
-            }
-        }
-        return prioritiesByIntValue.get(value);
+        return RulePriority.valueOf(value);
     }
 
     /**
      * Return the priority labels
      * 
      * @deprecated - not referenced in the modern UI
      */
+    @Deprecated
     public static String[] getPriorityLabels() {
         if (priorityLabels == null) {
             final StringTable stringTable = PMDPlugin.getDefault().getStringTable();

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/PMDMarkerImageProvider.java

@@ -9,7 +9,8 @@
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.ui.texteditor.IAnnotationImageProvider;
 
-import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
+import net.sourceforge.pmd.RulePriority;
+import net.sourceforge.pmd.eclipse.ui.priority.PriorityDescriptorCache;
 
 public class PMDMarkerImageProvider implements IAnnotationImageProvider {
 
@@ -25,19 +26,20 @@ public String getImageDescriptorId(Annotation annotation) {
 
     @Override
     public Image getManagedImage(Annotation annotation) {
-        PMDPlugin plugin = PMDPlugin.getDefault();
         String type = annotation.getType();
+        RulePriority priority = RulePriority.HIGH;
+
         if ("net.sourceforge.pmd.eclipse.plugin.annotation.prio1".equals(type)) {
-            return plugin.getImage(type, "icons/markerP1.png");
+            priority = RulePriority.HIGH;
         } else if ("net.sourceforge.pmd.eclipse.plugin.annotation.prio2".equals(type)) {
-            return plugin.getImage(type, "icons/markerP2.png");
+            priority = RulePriority.MEDIUM_HIGH;
         } else if ("net.sourceforge.pmd.eclipse.plugin.annotation.prio3".equals(type)) {
-            return plugin.getImage(type, "icons/markerP3.png");
+            priority = RulePriority.MEDIUM;
         } else if ("net.sourceforge.pmd.eclipse.plugin.annotation.prio4".equals(type)) {
-            return plugin.getImage(type, "icons/markerP4.png");
+            priority = RulePriority.MEDIUM_LOW;
         } else if ("net.sourceforge.pmd.eclipse.plugin.annotation.prio5".equals(type)) {
-            return plugin.getImage(type, "icons/markerP5.png");
+            priority = RulePriority.LOW;
         }
-        return null;
+        return PriorityDescriptorCache.INSTANCE.descriptorFor(priority).getAnnotationImage();
     }
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/RuleLabelDecorator.java

@@ -6,7 +6,6 @@
 
 import java.util.Collection;
 import java.util.HashSet;
-import java.util.Map;
 import java.util.Set;
 
 import org.eclipse.core.resources.IResource;
@@ -17,24 +16,19 @@
 import org.eclipse.jface.viewers.ILightweightLabelDecorator;
 import org.eclipse.jface.viewers.LabelProviderChangedEvent;
 
-import net.sourceforge.pmd.eclipse.plugin.UISettings;
+import net.sourceforge.pmd.RulePriority;
+import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
 import net.sourceforge.pmd.eclipse.runtime.PMDRuntimeConstants;
 import net.sourceforge.pmd.eclipse.runtime.builder.MarkerUtil;
+import net.sourceforge.pmd.eclipse.ui.priority.PriorityDescriptorCache;
 
 /**
  * 
  * @author Brian Remedios
  */
 public class RuleLabelDecorator implements ILightweightLabelDecorator {
-
     private Collection<ILabelProviderListener> listeners;
 
-    private Map<Integer, ImageDescriptor> overlaysByPriority;
-
-    public RuleLabelDecorator() {
-        reloadDecorators();
-    }
-
     public void addListener(ILabelProviderListener listener) {
         if (listeners == null) {
             listeners = new HashSet<ILabelProviderListener>();
@@ -59,8 +53,11 @@ public void changed(Collection<IResource> resources) {
 
     }
 
+    /**
+     * reloading is not necessary anymore
+     */
+    @Deprecated
     public void reloadDecorators() {
-        overlaysByPriority = UISettings.markerImgDescriptorsByPriority();
     }
 
     public boolean isLabelProperty(Object element, String property) {
@@ -93,18 +90,15 @@ public void decorate(Object element, IDecoration decoration) {
         }
 
         Integer first = range.iterator().next();
-        ImageDescriptor overlay = overlaysByPriority.get(first);
+        ImageDescriptor overlay = PriorityDescriptorCache.INSTANCE.descriptorFor(RulePriority.valueOf(first)).getAnnotationImageDescriptor();
 
         try {
             boolean hasMarkers = MarkerUtil.hasAnyRuleMarkers(resource);
             if (hasMarkers) {
                 decoration.addOverlay(overlay);
             }
         } catch (CoreException e) {
-            // TODO Auto-generated catch block
-            e.printStackTrace();
+            PMDPlugin.getDefault().logError("Error while adding overlay icon", e);
         }
-
     }
-
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/ShapeDescriptor.java

@@ -22,10 +22,6 @@ public ShapeDescriptor(Shape theShape, RGB theColor, int theSize) {
         size = theSize;
     }
 
-    private ShapeDescriptor() {
-
-    }
-
     public boolean equals(Object other) {
         if (other == null) {
             return false;
@@ -47,11 +43,7 @@ public int hashCode() {
     }
 
     public ShapeDescriptor clone() {
-
-        ShapeDescriptor copy = new ShapeDescriptor();
-        copy.shape = shape;
-        copy.rgbColor = new RGB(rgbColor.red, rgbColor.green, rgbColor.blue);
-        copy.size = size;
+        ShapeDescriptor copy = new ShapeDescriptor(shape, new RGB(rgbColor.red, rgbColor.green, rgbColor.blue), size);
         return copy;
     }