Add new options

Add new options to open to the violations overview or outline after a code review without going to the perspective.

Author: Phillip Krall

net.sourceforge.pmd.eclipse.plugin/messages.properties

@@ -24,6 +24,8 @@ preference.pmd.group.priorities = Priority levels
 preference.pmd.group.review = Violations review parameters
 preference.pmd.group.general = General options
 preference.pmd.label.perspective_on_check = Show PMD perspective when checking code
+preference.pmd.label.violationsoverview_on_check = Show PMD violations overview when checking code
+preference.pmd.label.violationsoutline_on_check = Show PMD violations outline when checking code
 preference.pmd.label.check_after_saving = Check code after saving
 preference.pmd.label.use_dfa = Enable dataflow anomaly analysis (experimental)
 preference.pmd.label.use_project_build_path = Enable using Java Project Build Path.  Disable if your Eclipse JVM version is incompatible with .class file versions.

net.sourceforge.pmd.eclipse.plugin/nl/fr/messages.properties

@@ -24,6 +24,8 @@ preference.pmd.group.priorities = Niveaux de priorit
 preference.pmd.group.review = Paramètres de revue des violations
 preference.pmd.group.general = Options générales
 preference.pmd.label.perspective_on_check = Basculer sur la perspective PMD après la vérification (mode manuel seulement)
+preference.pmd.label.violationsoverview_on_check = Afficher la synthèse des violations de PMD lors de la vérification du code
+preference.pmd.label.violationsoutline_on_check = Afficher les violations de PMD lors de la vérification du code
 preference.pmd.label.check_after_saving = Vérifier à chaque sauvegarde
 preference.pmd.label.use_dfa = Activer l'analyse d'anomalie de flots de données (expérimental)
 preference.pmd.label.use_project_build_path = Activer l'utilisation du chemin de construction du projet. A désactiver si la machine virtuelle de votre Eclipse est incompatible avec la version des fichiers .class.

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

@@ -46,6 +46,7 @@
 import org.eclipse.ui.IEditorPart;
 import org.eclipse.ui.IEditorReference;
 import org.eclipse.ui.IWorkbenchPart;
+import org.eclipse.ui.PartInitException;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.osgi.framework.Bundle;
@@ -88,6 +89,8 @@ public class PMDPlugin extends AbstractUIPlugin {
     private static File pluginFolder;
 
     private FileChangeReviewer changeReviewer;
+    public static final String VIOLATIONS_OVERVIEW_ID = "net.sourceforge.pmd.eclipse.ui.views.violationOverview";
+    public static final String VIOLATIONS_OUTLINE_ID = "net.sourceforge.pmd.eclipse.ui.views.violationOutline";
 
     private Map<RGB, Color> coloursByRGB = new HashMap<RGB, Color>();
 
@@ -264,6 +267,24 @@ public Set<IFile> getOpenFiles() {
         }
         return files;
     }
+    
+    /**
+     * Open a view to the id passed in.
+     * 
+     * @param viewId id of the view
+     */
+    public void showView(final String viewId) {
+        Display.getDefault().asyncExec(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().showView(viewId);
+                } catch (PartInitException e) {
+                    LOG.error(e);
+                }
+            }
+        });
+    }
 
     public void fileChangeListenerEnabled(boolean flag) {
 

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/cmd/ReviewCodeCmd.java

@@ -71,6 +71,8 @@
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.PlatformUI;
 
+import name.herlin.command.CommandException;
+import name.herlin.command.Timer;
 import net.sourceforge.pmd.Rule;
 import net.sourceforge.pmd.RuleSet;
 import net.sourceforge.pmd.eclipse.plugin.PMDPlugin;
@@ -82,9 +84,6 @@
 import net.sourceforge.pmd.eclipse.ui.actions.RuleSetUtil;
 import net.sourceforge.pmd.util.StringUtil;
 
-import name.herlin.command.CommandException;
-import name.herlin.command.Timer;
-
 /**
  * This command executes the PMD engine on a specified resource
  *
@@ -100,6 +99,8 @@ public class ReviewCodeCmd extends AbstractDefaultCommand {
     private Map<IFile, Set<MarkerInfo2>> markersByFile = new HashMap<IFile, Set<MarkerInfo2>>();
     private boolean taskMarker;
     private boolean openPmdPerspective;
+    private boolean openPmdViolationsOverviewView;
+    private boolean openPmdViolationsOutlineView;
     private int ruleCount;
     private int fileCount;
     private long pmdDuration;
@@ -144,6 +145,8 @@ public static void runCodeReviewOnFiles(Set<IFile> files) throws CommandExceptio
         cmd.setStepCount(files.size());
         cmd.setTaskMarker(true);
         cmd.setOpenPmdPerspective(PMDPlugin.getDefault().loadPreferences().isPmdPerspectiveEnabled());
+        cmd.setOpenPmdViolationsOverviewView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOverviewEnabled());
+        cmd.setOpenPmdViolationsOutlineView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOutlineEnabled());
         cmd.setUserInitiated(true);
         cmd.setRunAlways(true);
         for (IResource file : files) {
@@ -255,6 +258,14 @@ public void run() {
                 });
             }
 
+            if (openPmdViolationsOverviewView) {
+                PMDPlugin.getDefault().showView(PMDPlugin.VIOLATIONS_OVERVIEW_ID);
+            }
+            
+            if (openPmdViolationsOutlineView) {
+                PMDPlugin.getDefault().showView(PMDPlugin.VIOLATIONS_OUTLINE_ID);
+            }
+
         } catch (CoreException e) {
             throw new CommandException("Core exception when reviewing code", e);
         } finally {
@@ -338,6 +349,24 @@ public void setRunAlways(boolean runAlways) {
     public void setOpenPmdPerspective(boolean openPmdPerspective) {
         this.openPmdPerspective = openPmdPerspective;
     }
+    
+    /**
+     * Set the open violations view to run after code review.
+     * 
+     * @param openPmdViolationsView should open
+     */
+    public void setOpenPmdViolationsOverviewView(boolean openPmdViolationsView) {
+        this.openPmdViolationsOverviewView = openPmdViolationsView;
+    }
+    
+    /**
+     * Set the open violations outline view to run after code review.
+     * 
+     * @param openPmdViolationsOutlineView should open
+     */
+    public void setOpenPmdViolationsOutlineView(boolean openPmdViolationsOutlineView) {
+        this.openPmdViolationsOutlineView = openPmdViolationsOutlineView;
+    }
 
     /**
      * @see name.herlin.command.Command#reset()
@@ -348,6 +377,8 @@ public void reset() {
         markersByFile = new HashMap<IFile, Set<MarkerInfo2>>();
         setTerminated(false);
         openPmdPerspective = false;
+        openPmdViolationsOverviewView = false;
+        openPmdViolationsOutlineView = false;
         onErrorIssue = null;
         runAlways = false;
     }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/IPreferences.java

@@ -56,6 +56,8 @@ public interface IPreferences {
 
     boolean PROJECT_BUILD_PATH_ENABLED_DEFAULT = true;
     boolean PMD_PERSPECTIVE_ENABLED_DEFAULT = true;
+    boolean PMD_VIOLATIONS_OVERVIEW_ENABLED_DEFAULT = false;
+    boolean PMD_VIOLATIONS_OUTLINE_ENABLED_DEFAULT = false;
     boolean PMD_CHECK_AFTER_SAVE_DEFAULT = false;
     boolean PMD_USE_CUSTOM_PRIORITY_NAMES_DEFAULT = true;
     int MAX_VIOLATIONS_PFPR_DEFAULT = 5;
@@ -110,6 +112,18 @@ public interface IPreferences {
      * is launched ?
      */
     boolean isPmdPerspectiveEnabled();
+    
+    /**
+     * Should the plugin show the PMD violations overview when a code review is launched?
+     * @return
+     */
+    boolean isPmdViolationsOverviewEnabled();
+    
+    /**
+     * Should the plugin show the PMD violations outline when a code review is launched?
+     * @return
+     */
+    boolean isPmdViolationsOutlineEnabled();
 
     /**
      * Should the plugin scan any newly-saved code?
@@ -130,6 +144,18 @@ public interface IPreferences {
      * review is launched
      */
     void setPmdPerspectiveEnabled(boolean pmdPerspectiveEnabled);
+    
+    /**
+     * Set whether the plugin switch to the PMD violations overview when a manual code
+     * review is launched
+     */
+    void setPmdViolationsOverviewEnabled(boolean pmdViolationsOverviewEnabled);
+    
+    /**
+     * Set whether the plugin switch to the PMD violations outline when a manual code
+     * review is launched
+     */
+    void setPmdViolationsOutlineEnabled(boolean pmdViolationsOutlineEnabled);
 
     /**
      * Get the maximum number of violations per file per rule reported by the

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesImpl.java

@@ -66,6 +66,8 @@ class PreferencesImpl implements IPreferences {
     private IPreferencesManager preferencesManager;
     private boolean projectBuildPathEnabled;
     private boolean pmdPerspectiveEnabled;
+    private boolean pmdViolationsOverviewEnabled;
+    private boolean pmdViolationsOutlineEnabled;
     private boolean checkAfterSaveEnabled;
     private boolean useCustomPriorityNames;
     private int maxViolationsPerFilePerRule;
@@ -146,6 +148,14 @@ public void isCheckAfterSaveEnabled(boolean flag) {
     public void setPmdPerspectiveEnabled(boolean pmdPerspectiveEnabled) {
         this.pmdPerspectiveEnabled = pmdPerspectiveEnabled;
     }
+    
+    /**
+     * @see net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences#setPmdViolationsOverviewEnabled(boolean)
+     */
+    public void setPmdViolationsOverviewEnabled(boolean pmdViolationsOverviewEnabled) {
+        this.pmdViolationsOverviewEnabled = pmdViolationsOverviewEnabled;
+    }
+    
 
     /**
      * @see net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences#getMaxViolationsPerFilePerRule()
@@ -323,9 +333,25 @@ public void useCustomPriorityNames(boolean flag) {
     public Set<String> activeReportRenderers() {
         return activeRendererNames;
     }
-
+    
+    @Override
     public void activeReportRenderers(Set<String> names) {
         activeRendererNames = names;
     }
 
+    @Override
+    public boolean isPmdViolationsOverviewEnabled() {
+        return pmdViolationsOverviewEnabled;
+    }
+
+    @Override
+    public boolean isPmdViolationsOutlineEnabled() {
+        return pmdViolationsOutlineEnabled;
+    }
+
+    @Override
+    public void setPmdViolationsOutlineEnabled(boolean pmdViolationsOutlineEnabled) {
+        this.pmdViolationsOutlineEnabled = pmdViolationsOutlineEnabled;
+    }
+
 }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/runtime/preferences/impl/PreferencesManagerImpl.java

@@ -94,6 +94,8 @@ class PreferencesManagerImpl implements IPreferencesManager {
 
     private static final String PROJECT_BUILD_PATH_ENABLED = PMDPlugin.PLUGIN_ID + ".project_build_path_enabled";
     private static final String PMD_PERSPECTIVE_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_perspective_enabled";
+    private static final String PMD_VIOLATIONS_OVERVIEW_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_overview_enabled";
+    private static final String PMD_VIOLATIONS_OUTLINE_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_outline_enabled";
     private static final String PMD_CHECK_AFTER_SAVE_ENABLED = PMDPlugin.PLUGIN_ID + ".pmd_check_after_save_enabled";
     private static final String MAX_VIOLATIONS_PFPR = PMDPlugin.PLUGIN_ID + ".max_violations_pfpr";
     private static final String REVIEW_ADDITIONAL_COMMENT = PMDPlugin.PLUGIN_ID + ".review_additional_comment";
@@ -174,6 +176,8 @@ public IPreferences reloadPreferences() {
 
         loadProjectBuildPathEnabled();
         loadPmdPerspectiveEnabled();
+        loadPmdViolationsOverviewEnabled();
+        loadPmdViolationsOutlineEnabled();
         loadCheckAfterSaveEnabled();
         loadUseCustomPriorityNames();
         loadMaxViolationsPerFilePerRule();
@@ -238,6 +242,8 @@ public void storePreferences(IPreferences thePreferences) {
 
         storeProjectBuildPathEnabled();
         storePmdPerspectiveEnabled();
+        storePmdViolationsOverviewEnabled();
+        storePmdViolationsOutlineEnabled();
         storeCheckAfterSaveEnabled();
         storeUseCustomPriorityNames();
         storeMaxViolationsPerFilePerRule();
@@ -283,7 +289,17 @@ private void loadPmdPerspectiveEnabled() {
         loadPreferencesStore.setDefault(PMD_PERSPECTIVE_ENABLED, IPreferences.PMD_PERSPECTIVE_ENABLED_DEFAULT);
         preferences.setPmdPerspectiveEnabled(loadPreferencesStore.getBoolean(PMD_PERSPECTIVE_ENABLED));
     }
-
+    
+    private void loadPmdViolationsOverviewEnabled() {
+        loadPreferencesStore.setDefault(PMD_VIOLATIONS_OVERVIEW_ENABLED, IPreferences.PMD_VIOLATIONS_OVERVIEW_ENABLED_DEFAULT);
+        preferences.setPmdPerspectiveEnabled(loadPreferencesStore.getBoolean(PMD_VIOLATIONS_OVERVIEW_ENABLED));
+    }
+    
+    private void loadPmdViolationsOutlineEnabled() {
+        loadPreferencesStore.setDefault(PMD_VIOLATIONS_OUTLINE_ENABLED, IPreferences.PMD_VIOLATIONS_OUTLINE_ENABLED_DEFAULT);
+        preferences.setPmdPerspectiveEnabled(loadPreferencesStore.getBoolean(PMD_VIOLATIONS_OUTLINE_ENABLED));
+    }
+    
     private void loadCheckAfterSaveEnabled() {
         loadPreferencesStore.setDefault(PMD_CHECK_AFTER_SAVE_ENABLED, IPreferences.PMD_CHECK_AFTER_SAVE_DEFAULT);
         preferences.isCheckAfterSaveEnabled(loadPreferencesStore.getBoolean(PMD_CHECK_AFTER_SAVE_ENABLED));
@@ -428,6 +444,14 @@ private void storePmdPerspectiveEnabled() {
         storePreferencesStore.setValue(PMD_PERSPECTIVE_ENABLED, preferences.isPmdPerspectiveEnabled());
     }
 
+    private void storePmdViolationsOverviewEnabled() {
+        storePreferencesStore.setValue(PMD_VIOLATIONS_OVERVIEW_ENABLED, preferences.isPmdViolationsOverviewEnabled());
+    }
+    
+    private void storePmdViolationsOutlineEnabled() {
+        storePreferencesStore.setValue(PMD_VIOLATIONS_OUTLINE_ENABLED, preferences.isPmdViolationsOutlineEnabled());
+    }
+    
     private void storeMaxViolationsPerFilePerRule() {
         storePreferencesStore.setValue(MAX_VIOLATIONS_PFPR, preferences.getMaxViolationsPerFilePerRule());
     }

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/actions/PMDCheckAction.java

@@ -131,6 +131,8 @@ private void setupAndExecute(ReviewCodeCmd cmd, int count) throws CommandExcepti
         cmd.setStepCount(count);
         cmd.setTaskMarker(true);
         cmd.setOpenPmdPerspective(PMDPlugin.getDefault().loadPreferences().isPmdPerspectiveEnabled());
+        cmd.setOpenPmdViolationsOverviewView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOverviewEnabled());
+        cmd.setOpenPmdViolationsOutlineView(PMDPlugin.getDefault().loadPreferences().isPmdViolationsOutlineEnabled());
         cmd.setUserInitiated(true);
         cmd.setRunAlways(true);
         cmd.performExecute();

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/nls/StringKeys.java

@@ -66,6 +66,9 @@ public class StringKeys {
     public static final String PREF_GENERAL_GROUP_PRIORITIES = "preference.pmd.group.priorities";
     public static final String PREF_GENERAL_GROUP_GENERAL = "preference.pmd.group.general";
     public static final String PREF_GENERAL_LABEL_SHOW_PERSPECTIVE = "preference.pmd.label.perspective_on_check";
+    // TODO (pk) Add the Fr version
+    public static final String PREF_GENERAL_LABEL_SHOW_VIOLATIONS_OVERVIEW = "preference.pmd.label.violationsoverview_on_check";
+    public static final String PREF_GENERAL_LABEL_SHOW_VIOLATIONS_OUTLINE = "preference.pmd.label.violationsoutline_on_check";
     public static final String PREF_GENERAL_LABEL_CHECK_AFTER_SAVING = "preference.pmd.label.check_after_saving";
     public static final String PREF_GENERAL_LABEL_USE_DFA = "preference.pmd.label.use_dfa";
     public static final String PREF_GENERAL_LABEL_USE_PROJECT_BUILD_PATH = "preference.pmd.label.use_project_build_path";