Fix #13751 (cmdlineparser: --file-filter matching of looked up files in provided paths) (danmar#7517)

Author: danmar

cli/cmdlineparser.cpp

@@ -308,9 +308,7 @@ bool CmdLineParser::fillSettingsFromArgs(int argc, const char* const argv[])
 
         std::list<FileWithDetails> files;
         if (!mSettings.fileFilters.empty()) {
-            std::copy_if(filesResolved.cbegin(), filesResolved.cend(), std::inserter(files, files.end()), [&](const FileWithDetails& entry) {
-                return matchglobs(mSettings.fileFilters, entry.path());
-            });
+            files = filterFiles(mSettings.fileFilters, filesResolved);
             if (files.empty()) {
                 mLogger.printError("could not find any files matching the filter.");
                 return false;
@@ -2185,3 +2183,16 @@ bool CmdLineParser::loadCppcheckCfg()
     return true;
 }
 
+std::list<FileWithDetails> CmdLineParser::filterFiles(const std::vector<std::string>& fileFilters,
+                                                      const std::list<FileWithDetails>& filesResolved) {
+    std::list<FileWithDetails> files;
+#ifdef _WIN32
+    constexpr bool caseInsensitive = true;
+#else
+    constexpr bool caseInsensitive = false;
+#endif
+    std::copy_if(filesResolved.cbegin(), filesResolved.cend(), std::inserter(files, files.end()), [&](const FileWithDetails& entry) {
+        return matchglobs(fileFilters, entry.path(), caseInsensitive) || matchglobs(fileFilters, entry.spath(), caseInsensitive);
+    });
+    return files;
+}

cli/cmdlineparser.h

@@ -68,6 +68,16 @@ class CmdLineParser {
      */
     bool fillSettingsFromArgs(int argc, const char* const argv[]);
 
+    /**
+     * @brief Filter files
+     *
+     * @param fileFilters file filters
+     * @param filesResolved all the files in project
+     * @return the files in filesResolved that match filters
+     */
+    static std::list<FileWithDetails> filterFiles(const std::vector<std::string>& fileFilters,
+                                                  const std::list<FileWithDetails>& filesResolved);
+
     /**
      * Parse given command line.
      * @return true if command line was ok, false if there was an error.

lib/utils.cpp

@@ -51,7 +51,7 @@ bool isValidGlobPattern(const std::string& pattern)
     return true;
 }
 
-bool matchglob(const std::string& pattern, const std::string& name)
+bool matchglob(const std::string& pattern, const std::string& name, bool caseInsensitive)
 {
     const char* p = pattern.c_str();
     const char* n = name.c_str();
@@ -83,6 +83,8 @@ bool matchglob(const std::string& pattern, const std::string& name)
                 // Non-wildcard characters match literally
                 if (*n == *p) {
                     n++;
+                } else if (caseInsensitive && tolower(*n) == tolower(*p)) {
+                    n++;
                 } else if (*n == '\\' && *p == '/') {
                     n++;
                 } else if (*n == '/' && *p == '\\') {
@@ -115,9 +117,9 @@ bool matchglob(const std::string& pattern, const std::string& name)
     }
 }
 
-bool matchglobs(const std::vector<std::string> &patterns, const std::string &name) {
-    return std::any_of(begin(patterns), end(patterns), [&name](const std::string &pattern) {
-        return matchglob(pattern, name);
+bool matchglobs(const std::vector<std::string> &patterns, const std::string &name, bool caseInsensitive) {
+    return std::any_of(begin(patterns), end(patterns), [&name, caseInsensitive](const std::string &pattern) {
+        return matchglob(pattern, name, caseInsensitive);
     });
 }
 

lib/utils.h

@@ -202,9 +202,9 @@ CPPCHECKLIB int caseInsensitiveStringCompare(const std::string& lhs, const std::
 
 CPPCHECKLIB bool isValidGlobPattern(const std::string& pattern);
 
-CPPCHECKLIB bool matchglob(const std::string& pattern, const std::string& name);
+CPPCHECKLIB bool matchglob(const std::string& pattern, const std::string& name, bool caseInsensitive = false);
 
-CPPCHECKLIB bool matchglobs(const std::vector<std::string> &patterns, const std::string &name);
+CPPCHECKLIB bool matchglobs(const std::vector<std::string> &patterns, const std::string &name, bool caseInsensitive = false);
 
 CPPCHECKLIB void strTolower(std::string& str);
 

releasenotes.txt

@@ -24,4 +24,5 @@ Other:
 - The minimum supported Python version has been bumped to 3.7.
 - CMake will now unconditionally use Boost.Containers if available. If CMake option `USE_BOOST` is specified it will now bail out when it is not found.
 - Fix checking a project that contains several project file entries for the same file.
+- Fixed --file-filter matching of looked up files in provided paths.
 -

test/testcmdlineparser.cpp

@@ -204,6 +204,8 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(exitcodeSuppressionsOld);
         TEST_CASE(exitcodeSuppressions);
         TEST_CASE(exitcodeSuppressionsNoFile);
+        TEST_CASE(fileFilterFileWithDetailsSimplifiedPath);
+        TEST_CASE(fileFilterFileWithDetailsCase);
         TEST_CASE(fileFilterStdin);
         TEST_CASE(fileList);
         TEST_CASE(fileListNoFile);
@@ -1185,6 +1187,26 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS("cppcheck: error: unrecognized command line option: \"--exitcode-suppressions\".\n", logger->str());
     }
 
+    void fileFilterFileWithDetailsSimplifiedPath() const {
+        // match against simplified path
+        const std::vector<std::string> fileFilters{"m1.c"};
+        const std::list<FileWithDetails> filesResolved{ FileWithDetails("./m1.c", Standards::Language::C, 123) };
+        const std::list<FileWithDetails> files = CmdLineParser::filterFiles(fileFilters, filesResolved);
+        ASSERT_EQUALS(1U, files.size());
+    }
+
+    void fileFilterFileWithDetailsCase() {
+        // in windows, paths are case insensitive
+        const std::vector<std::string> fileFilters{"m1.c"};
+        const std::list<FileWithDetails> filesResolved{ FileWithDetails("M1.C", Standards::Language::C, 123) };
+        const std::list<FileWithDetails> files = CmdLineParser::filterFiles(fileFilters, filesResolved);
+#ifdef _WIN32
+        ASSERT_EQUALS(1U, files.size());
+#else
+        ASSERT_EQUALS(0U, files.size());
+#endif
+    }
+
     void fileFilterStdin() {
         REDIRECT;
         RedirectInput input("file1.c\nfile2.cpp\n");