Add new checkbox in general preferences: Determine applicable file types automatically

Author: adangel

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

@@ -30,6 +30,7 @@ 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.
 preference.pmd.label.max_violations_pfpr = Maximum reported violations per file per rule
+preference.pmd.label.determine_filetypes_automatically = Determine applicable file types automatically (based on rule languages)
 preference.pmd.tooltip.max_violations_pfpr = This helps limit report sizes and improves overall performance
 preference.pmd.message.invalid_numeric_value = Incorrect numeric value entered
 preference.pmd.label.review_pmd_style = Use PMD style (// NOPMD comment)

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

@@ -29,6 +29,7 @@ public interface IPreferences {
     boolean PMD_CHECK_AFTER_SAVE_DEFAULT = false;
     boolean PMD_USE_CUSTOM_PRIORITY_NAMES_DEFAULT = true;
     int MAX_VIOLATIONS_PFPR_DEFAULT = 5;
+    boolean DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT = true;
     String REVIEW_ADDITIONAL_COMMENT_DEFAULT = "by {0} on {1}";
     boolean REVIEW_PMD_STYLE_ENABLED_DEFAULT = true;
     int MIN_TILE_SIZE_DEFAULT = 25;
@@ -143,6 +144,19 @@ public interface IPreferences {
      */
     void setMaxViolationsPerFilePerRule(int maxViolationPerFilePerRule);
 
+    /**
+     * If true: When checking, whether a given file should be analyzed by PMD, take
+     * the rule's language and the language's file extensions into account.
+     * @return
+     */
+    boolean isDetermineFiletypesAutomatically();
+
+    /**
+     * Sets whether the rule's language file extensions should be considered or not.
+     * @param determineFiletypesAutomatically
+     */
+    void setDetermineFiletypesAutomatically(boolean determineFiletypesAutomatically);
+
     /**
      * Get the review additional comment. This comment is a text appended to the
      * review comment that is inserted into the code when a violation is

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

@@ -39,6 +39,7 @@ class PreferencesImpl implements IPreferences {
     private boolean checkAfterSaveEnabled;
     private boolean useCustomPriorityNames;
     private int maxViolationsPerFilePerRule;
+    private boolean determineFiletypesAutomatically;
     private String reviewAdditionalComment;
     private boolean reviewPmdStyleEnabled;
     private int minTileSize;
@@ -146,6 +147,16 @@ public void setMaxViolationsPerFilePerRule(int maxViolationPerFilePerRule) {
         this.maxViolationsPerFilePerRule = maxViolationPerFilePerRule;
     }
 
+    @Override
+    public boolean isDetermineFiletypesAutomatically() {
+        return determineFiletypesAutomatically;
+    }
+
+    @Override
+    public void setDetermineFiletypesAutomatically(boolean determineFiletypesAutomatically) {
+        this.determineFiletypesAutomatically = determineFiletypesAutomatically;
+    }
+
     /**
      * @see net.sourceforge.pmd.eclipse.runtime.preferences.IPreferences#getReviewAdditionalComment()
      */

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

@@ -68,6 +68,7 @@ class PreferencesManagerImpl implements IPreferencesManager {
     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 DETERMINE_FILETYPES_AUTOMATICALLY = PMDPlugin.PLUGIN_ID + ".determine_filetypes_automatically";
     private static final String REVIEW_ADDITIONAL_COMMENT = PMDPlugin.PLUGIN_ID + ".review_additional_comment";
     private static final String REVIEW_PMD_STYLE_ENABLED = PMDPlugin.PLUGIN_ID + ".review_pmd_style_enabled";
     private static final String PMD_USE_CUSTOM_PRIORITY_NAMES = PMDPlugin.PLUGIN_ID + ".use_custom_priority_names";
@@ -159,6 +160,7 @@ public IPreferences reloadPreferences() {
         loadCheckAfterSaveEnabled();
         loadUseCustomPriorityNames();
         loadMaxViolationsPerFilePerRule();
+        loadDetermineFiletypesAutomatically();
         loadReviewAdditionalComment();
         loadReviewPmdStyleEnabled();
         loadMinTileSize();
@@ -231,6 +233,7 @@ public void storePreferences(IPreferences thePreferences) {
         storeCheckAfterSaveEnabled();
         storeUseCustomPriorityNames();
         storeMaxViolationsPerFilePerRule();
+        storeDetermineFiletypesAutomatically();
         storeReviewAdditionalComment();
         storeReviewPmdStyleEnabled();
         storeMinTileSize();
@@ -305,6 +308,11 @@ private void loadMaxViolationsPerFilePerRule() {
         loadPreferencesStore.setDefault(MAX_VIOLATIONS_PFPR, IPreferences.MAX_VIOLATIONS_PFPR_DEFAULT);
         preferences.setMaxViolationsPerFilePerRule(loadPreferencesStore.getInt(MAX_VIOLATIONS_PFPR));
     }
+    
+    private void loadDetermineFiletypesAutomatically() {
+        loadPreferencesStore.setDefault(DETERMINE_FILETYPES_AUTOMATICALLY, IPreferences.DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT);
+        preferences.setDetermineFiletypesAutomatically(loadPreferencesStore.getBoolean(DETERMINE_FILETYPES_AUTOMATICALLY));
+    }
 
     private void loadReviewAdditionalComment() {
         loadPreferencesStore.setDefault(REVIEW_ADDITIONAL_COMMENT, IPreferences.REVIEW_ADDITIONAL_COMMENT_DEFAULT);
@@ -486,6 +494,10 @@ private void storeMaxViolationsPerFilePerRule() {
         storePreferencesStore.setValue(MAX_VIOLATIONS_PFPR, preferences.getMaxViolationsPerFilePerRule());
     }
 
+    private void storeDetermineFiletypesAutomatically() {
+        storePreferencesStore.setValue(DETERMINE_FILETYPES_AUTOMATICALLY, preferences.isDetermineFiletypesAutomatically());
+    }
+
     private void storeReviewAdditionalComment() {
         storePreferencesStore.setValue(REVIEW_ADDITIONAL_COMMENT, preferences.getReviewAdditionalComment());
     }

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

@@ -41,6 +41,7 @@ public class StringKeys {
     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";
     public static final String PREF_GENERAL_LABEL_MAX_VIOLATIONS_PFPR = "preference.pmd.label.max_violations_pfpr";
+    public static final String PREF_GENERAL_LABEL_DETERMINE_FILETYPES_AUTOMATICALLY = "preference.pmd.label.determine_filetypes_automatically";
     public static final String PREF_GENERAL_TOOLTIP_MAX_VIOLATIONS_PFPR = "preference.pmd.tooltip.max_violations_pfpr";
     public static final String PREF_GENERAL_MESSAGE_INVALID_NUMERIC_VALUE = "preference.pmd.message.invalid_numeric_value";
     public static final String PREF_GENERAL_REVIEW_PMD_STYLE = "preference.pmd.label.review_pmd_style";

net.sourceforge.pmd.eclipse.plugin/src/main/java/net/sourceforge/pmd/eclipse/ui/preferences/GeneralPreferencesPage.java

@@ -100,6 +100,7 @@ public class GeneralPreferencesPage extends PreferencePage implements IWorkbench
     private TableViewer tableViewer;
     private IPreferences preferences;
     private BasicTableManager priorityTableMgr;
+    private Button determineFiletypesAutomatically;
 
     private Control[] nameFields;
 
@@ -165,6 +166,7 @@ private Group buildGeneralGroup(final Composite parent) {
         showViolationsOutlineViewBox = buildShowViolationOutlineBoxButton(group);
         useProjectBuildPath = buildUseProjectBuildPathButton(group);
         checkCodeOnSave = buildCheckCodeOnSaveButton(group);
+        determineFiletypesAutomatically = buildDetermineFiletypesAutomatically(group);
         Label separator = new Label(group, SWT.SEPARATOR | SWT.SHADOW_IN | SWT.HORIZONTAL);
         maxViolationsPerFilePerRule = buildMaxViolationsPerFilePerRuleText(group);
 
@@ -709,6 +711,13 @@ private Spinner buildMaxViolationsPerFilePerRuleText(Composite parent) {
         return spinner;
     }
 
+    private Button buildDetermineFiletypesAutomatically(Composite viewGroup) {
+        Button button = new Button(viewGroup, SWT.CHECK);
+        button.setText(getMessage(StringKeys.PREF_GENERAL_LABEL_DETERMINE_FILETYPES_AUTOMATICALLY));
+        button.setSelection(preferences.isDetermineFiletypesAutomatically());
+        return button;
+    }
+
     /**
      * Build the check box for enabling PMD review style
      * 
@@ -752,6 +761,7 @@ protected void performDefaults() {
         setSelection(useCustomPriorityNames, IPreferences.PMD_USE_CUSTOM_PRIORITY_NAMES_DEFAULT);
         setSelection(useProjectBuildPath, IPreferences.PROJECT_BUILD_PATH_ENABLED_DEFAULT);
         setSelection(reviewPmdStyleBox, IPreferences.REVIEW_PMD_STYLE_ENABLED_DEFAULT);
+        setSelection(determineFiletypesAutomatically, IPreferences.DETERMINE_FILETYPES_AUTOMATICALLY_DEFAULT);
 
         if (maxViolationsPerFilePerRule != null) {
             maxViolationsPerFilePerRule.setMinimum(IPreferences.MAX_VIOLATIONS_PFPR_DEFAULT);
@@ -886,6 +896,10 @@ public boolean performOk() {
                     .setMaxViolationsPerFilePerRule(Integer.valueOf(maxViolationsPerFilePerRule.getText()).intValue());
         }
 
+        if (determineFiletypesAutomatically != null) {
+            preferences.setDetermineFiletypesAutomatically(determineFiletypesAutomatically.getSelection());
+        }
+
         if (reviewPmdStyleBox != null) {
             preferences.setReviewPmdStyleEnabled(reviewPmdStyleBox.getSelection());
         }