Merge pull request #59 from firewave/extensions

firewave · web-flow · commit 77d081fafa69 · 2020-12-23T14:28:13.000+01:00
added more supported extensions to match ones supported by Cppcheck internally
diff --git a/README.md b/README.md
@@ -62,6 +62,7 @@ Deployment.
 - Only scan files which actually exist. (Contribution by @firewave)
 - Use unique file names for temporary files used for analysis. (Contribution by @firewave)
 - Properly handle `debug` messages generated by `--debug-warnings`. (Contribution by @firewave)
+- Added `.cl`, `.hxx`, `.tpp` and `.txx` to list of supported file extensions - now matches the ones supported by Cppcheck internally. (Contribution by @firewave)
 
 ### 1.5.1 - 2020-11-12
 
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -66,6 +66,7 @@
       - Only scan files which actually exist. (Contribution by @firewave)
       - Use unique file names for temporary files used for analysis. (Contribution by @firewave)
       - Properly handle "debug" messages generated by --debug-warnings. (Contribution by @firewave
+      - Added .cl, .hxx, .tpp and .txx to list of supported file extensions - now matches the ones supported by Cppcheck internally. (Contribution by @firewave
     ]]>
   </change-notes>
 
diff --git a/src/com/github/johnthagen/cppcheck/Configuration.java b/src/com/github/johnthagen/cppcheck/Configuration.java
@@ -9,7 +9,7 @@
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
 
-public class Configuration implements Configurable {
+class Configuration implements Configurable {
     private boolean modified = false;
     private JFilePicker cppcheckFilePicker;
     private JTextField cppcheckOptionsField;
@@ -105,7 +105,7 @@ public boolean isModified() {
     }
 
     private void setModified() {
-        this.modified = true;
+        modified = true;
     }
 
     @Override
@@ -140,22 +140,22 @@ public void disposeUIResources() {
     private static class CppcheckConfigurationModifiedListener implements DocumentListener {
         private final Configuration option;
 
-        CppcheckConfigurationModifiedListener(Configuration option) {
+        CppcheckConfigurationModifiedListener(final Configuration option) {
             this.option = option;
         }
 
         @Override
-        public void insertUpdate(DocumentEvent documentEvent) {
+        public void insertUpdate(final DocumentEvent documentEvent) {
             option.setModified();
         }
 
         @Override
-        public void removeUpdate(DocumentEvent documentEvent) {
+        public void removeUpdate(final DocumentEvent documentEvent) {
             option.setModified();
         }
 
         @Override
-        public void changedUpdate(DocumentEvent documentEvent) {
+        public void changedUpdate(final DocumentEvent documentEvent) {
             option.setModified();
         }
     }
diff --git a/src/com/github/johnthagen/cppcheck/CppCheckInspectionImpl.java b/src/com/github/johnthagen/cppcheck/CppCheckInspectionImpl.java
@@ -35,7 +35,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class CppCheckInspectionImpl {
+class CppCheckInspectionImpl {
     private static ProblemHighlightType severityToHighlightType(@NotNull final String severity) {
         switch (severity) {
             case "error":
@@ -77,8 +77,8 @@ public static List<ProblemDescriptor> parseOutput(@NotNull final PsiFile psiFile
 
         final List<ProblemDescriptor> descriptors = new ArrayList<>();
 
-        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
-        DocumentBuilder db = dbf.newDocumentBuilder();
+        final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+        final DocumentBuilder db = dbf.newDocumentBuilder();
         final org.w3c.dom.Document doc = db.parse(new InputSource(new StringReader(cppcheckOutput)));
 
         final NodeList errors = doc.getElementsByTagName("error");
diff --git a/src/com/github/johnthagen/cppcheck/CppcheckError.java b/src/com/github/johnthagen/cppcheck/CppcheckError.java
@@ -2,7 +2,7 @@
 
 import org.jetbrains.annotations.NotNull;
 
-public class CppcheckError extends Error {
+class CppcheckError extends Error {
     public CppcheckError(@NotNull final String message)
     {
         super(message);
diff --git a/src/com/github/johnthagen/cppcheck/CppcheckInspection.java b/src/com/github/johnthagen/cppcheck/CppcheckInspection.java
@@ -21,14 +21,17 @@
 import javax.xml.parsers.ParserConfigurationException;
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.List;
 
-public class CppcheckInspection extends LocalInspectionTool {
+class CppcheckInspection extends LocalInspectionTool {
     @Nullable
     @Override
-    public ProblemDescriptor[] checkFile(@NotNull PsiFile file,
-                                         @NotNull InspectionManager manager,
-                                         boolean isOnTheFly) {
+    public ProblemDescriptor[] checkFile(@NotNull final PsiFile file,
+                                         @NotNull final InspectionManager manager,
+                                         final boolean isOnTheFly) {
         final VirtualFile vFile = file.getVirtualFile();
         if (vFile == null || !vFile.isInLocalFileSystem() || !isCFamilyFile(vFile)) {
             return ProblemDescriptor.EMPTY_ARRAY;
@@ -65,7 +68,7 @@ public ProblemDescriptor[] checkFile(@NotNull PsiFile file,
             final List<ProblemDescriptor> descriptors = CppCheckInspectionImpl.parseOutput(file, manager, document, cppcheckOutput,
                     tempFile.getName());
             return descriptors.toArray(new ProblemDescriptor[0]);
-        } catch (ExecutionException | CppcheckError | IOException | SAXException | ParserConfigurationException ex) {
+        } catch (final ExecutionException | CppcheckError | IOException | SAXException | ParserConfigurationException ex) {
             Notifications.Bus.notify(new Notification("Cppcheck",
                     "Cppcheck execution failed.",
                     ex.getClass().getSimpleName() + ": " + ex.getMessage(),
@@ -80,7 +83,7 @@ public ProblemDescriptor[] checkFile(@NotNull PsiFile file,
     }
 
     @NotNull
-    private static String prependIncludeDir(@NotNull String cppcheckOptions, @NotNull VirtualFile vFile) {
+    private static String prependIncludeDir(@NotNull final String cppcheckOptions, @NotNull final VirtualFile vFile) {
         final VirtualFile dir = vFile.getParent();
         if (dir == null) {
             return cppcheckOptions;
@@ -92,21 +95,51 @@ private static String prependIncludeDir(@NotNull String cppcheckOptions, @NotNul
         return String.format("-I\"%s\" %s", path, cppcheckOptions);
     }
 
+    // TODO: get the list of supported extensions from Cppcheck if it provides that information
+    // TODO: extend list by extensions configured within CLion
+    private final static List<String> supportedCExtensions = new ArrayList<>(Arrays.asList(
+            "c",
+            "cl"));
+
+    private final static List<String> supportedCPPExtensions = new ArrayList<>(Arrays.asList(
+            "cc",
+            "cp",
+            "cpp",
+            "c++",
+            "cxx",
+            "hh",
+            "hpp",
+            "hxx",
+            "tpp",
+            "txx"));
+
+    private final static List<String> supportedHeaderExtensions = new ArrayList<>(Collections.singletonList(
+            "h"));
+
     private static boolean isCFamilyFile(@NotNull final VirtualFile file) {
+        return isCFile(file) || isCPPFile(file) || isHeaderFile(file);
+    }
+
+    static private boolean isFile(@NotNull final VirtualFile file, @NotNull final List<String> supportedExtensions)
+    {
         final String fileExtension = file.getExtension();
         if (fileExtension == null) {
             return false;
         }
 
         final String lowerFileExtension = fileExtension.toLowerCase();
-        return lowerFileExtension.equals("c") ||
-                lowerFileExtension.equals("cc") ||
-                lowerFileExtension.equals("cp") ||
-                lowerFileExtension.equals("cpp") ||
-                lowerFileExtension.equals("c++") ||
-                lowerFileExtension.equals("cxx") ||
-                lowerFileExtension.equals("h") ||
-                lowerFileExtension.equals("hh") ||
-                lowerFileExtension.equals("hpp");
+        return supportedExtensions.contains(lowerFileExtension);
+    }
+
+    static private boolean isCFile(@NotNull final VirtualFile file) {
+        return isFile(file, supportedCExtensions);
+    }
+
+    static private boolean isCPPFile(@NotNull final VirtualFile file) {
+        return isFile(file, supportedCPPExtensions);
+    }
+
+    static private boolean isHeaderFile(@NotNull final VirtualFile file) {
+        return isFile(file, supportedHeaderExtensions);
     }
 }
diff --git a/src/com/github/johnthagen/cppcheck/JFilePicker.java b/src/com/github/johnthagen/cppcheck/JFilePicker.java
@@ -11,7 +11,7 @@ class JFilePicker extends JPanel {
     private final JTextField textField;
     private final JFileChooser fileChooser;
 
-    JFilePicker(String textFieldLabel, String buttonLabel) {
+    JFilePicker(final String textFieldLabel, final String buttonLabel) {
         fileChooser = new JFileChooser();
 
         setLayout(new FlowLayout(FlowLayout.CENTER, 5, 5));
diff --git a/src/com/github/johnthagen/cppcheck/Properties.java b/src/com/github/johnthagen/cppcheck/Properties.java
@@ -5,11 +5,11 @@
 class Properties {
     private static final PropertiesComponent INSTANCE = PropertiesComponent.getInstance();
 
-    static void set(String key, String value) {
+    static void set(final String key, final String value) {
         INSTANCE.setValue(key, value);
     }
 
-    static String get(String key) {
+    static String get(final String key) {
         return INSTANCE.getValue(key);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`import javax.swing.event.DocumentEvent;`
`10`	`10`	`import javax.swing.event.DocumentListener;`
`11`	`11`
`12`		`-public class Configuration implements Configurable {`
	`12`	`+class Configuration implements Configurable {`
`13`	`13`	`private boolean modified = false;`
`14`	`14`	`private JFilePicker cppcheckFilePicker;`
`15`	`15`	`private JTextField cppcheckOptionsField;`
`@@ -105,7 +105,7 @@ public boolean isModified() {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`private void setModified() {`
`108`		`- this.modified = true;`
	`108`	`+ modified = true;`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`@Override`
`@@ -140,22 +140,22 @@ public void disposeUIResources() {`
`140`	`140`	`private static class CppcheckConfigurationModifiedListener implements DocumentListener {`
`141`	`141`	`private final Configuration option;`
`142`	`142`
`143`		`- CppcheckConfigurationModifiedListener(Configuration option) {`
	`143`	`+ CppcheckConfigurationModifiedListener(final Configuration option) {`
`144`	`144`	`this.option = option;`
`145`	`145`	`}`
`146`	`146`
`147`	`147`	`@Override`
`148`		`- public void insertUpdate(DocumentEvent documentEvent) {`
	`148`	`+ public void insertUpdate(final DocumentEvent documentEvent) {`
`149`	`149`	`option.setModified();`
`150`	`150`	`}`
`151`	`151`
`152`	`152`	`@Override`
`153`		`- public void removeUpdate(DocumentEvent documentEvent) {`
	`153`	`+ public void removeUpdate(final DocumentEvent documentEvent) {`
`154`	`154`	`option.setModified();`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`@Override`
`158`		`- public void changedUpdate(DocumentEvent documentEvent) {`
	`158`	`+ public void changedUpdate(final DocumentEvent documentEvent) {`
`159`	`159`	`option.setModified();`
`160`	`160`	`}`
`161`	`161`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`import org.jetbrains.annotations.NotNull;`
`4`	`4`
`5`		`-public class CppcheckError extends Error {`
	`5`	`+class CppcheckError extends Error {`
`6`	`6`	`public CppcheckError(@NotNull final String message)`
`7`	`7`	`{`
`8`	`8`	`super(message);`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,11 @@`
`5`	`5`	`class Properties {`
`6`	`6`	`private static final PropertiesComponent INSTANCE = PropertiesComponent.getInstance();`
`7`	`7`
`8`		`- static void set(String key, String value) {`
	`8`	`+ static void set(final String key, final String value) {`
`9`	`9`	`INSTANCE.setValue(key, value);`
`10`	`10`	`}`
`11`	`11`
`12`		`- static String get(String key) {`
	`12`	`+ static String get(final String key) {`
`13`	`13`	`return INSTANCE.getValue(key);`
`14`	`14`	`}`
`15`	`15`	`}`