Fix #15081 (usability: try to report misuse of exclude options)

Author: dmcppcheck

cli/cmdlineparser.cpp

@@ -247,7 +247,7 @@ bool CmdLineParser::fillSettingsFromArgs(int argc, const char* const argv[])
         std::list<FileWithDetails> filesResolved;
         // Execute recursiveAddFiles() to each given file parameter
         // TODO: verbose log which files were ignored?
-        const PathMatch matcher(ignored, Path::getCurrentPath());
+        PathMatch matcher(ignored, Path::getCurrentPath());
         for (const std::string &pathname : pathnamesRef) {
             const std::string err = FileLister::recursiveAddFiles(filesResolved, Path::toNativeSeparators(pathname), mSettings.library.markupExtensions(), matcher, mSettings.debugignore);
             if (!err.empty()) {
@@ -264,6 +264,12 @@ bool CmdLineParser::fillSettingsFromArgs(int argc, const char* const argv[])
             return false;
         }
 
+        const auto& unmatched = matcher.unmatched();
+        if (!unmatched.empty()) {
+            mLogger.printError("unused ignore/exclude path '" + unmatched.front() + "' to hide warnings in certain files use suppressions instead.");
+            return false;
+        }
+
         std::list<FileWithDetails> files;
         if (!mSettings.fileFilters.empty()) {
             files = filterFiles(mSettings.fileFilters, filesResolved);
@@ -1723,12 +1729,16 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
         mPathNames = project.guiProject.pathNames;
 
     if (!project.fileSettings.empty()) {
-        project.ignorePaths(mIgnoredPaths, mSettings.debugignore);
+        const auto& unmatched = project.ignorePaths(mIgnoredPaths, mSettings.debugignore);
         if (project.fileSettings.empty()) {
             mLogger.printError("no C or C++ source files found.");
             mLogger.printMessage("all paths were ignored"); // TODO: log this differently?
             return Result::Fail;
         }
+        if (!unmatched.empty()) {
+            mLogger.printError("unused ignore/exclude path '" + unmatched.front() + "' to hide warnings in certain files use suppressions instead.");
+            return Result::Fail;
+        }
         mFileSettings = project.fileSettings;
     }
 

cli/filelister.cpp

@@ -46,7 +46,7 @@
 // When compiling Unicode targets WinAPI automatically uses *W Unicode versions
 // of called functions. Thus, we explicitly call *A versions of the functions.
 
-static std::string addFiles2(std::list<FileWithDetails>&files, const std::string &path, const std::set<std::string> &extra, bool recursive, const PathMatch& ignored, bool debug = false)
+static std::string addFiles2(std::list<FileWithDetails>&files, const std::string &path, const std::set<std::string> &extra, bool recursive, PathMatch& ignored, bool debug = false)
 {
     const std::string cleanedPath = Path::toNativeSeparators(path);
 
@@ -163,7 +163,7 @@ static std::string addFiles2(std::list<FileWithDetails>&files, const std::string
     return "";
 }
 
-std::string FileLister::addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, const PathMatch& ignored, bool debug)
+std::string FileLister::addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, PathMatch& ignored, bool debug)
 {
     if (path.empty())
         return "no path specified";
@@ -201,7 +201,7 @@ static std::string addFiles2(std::list<FileWithDetails> &files,
                              const std::string &path,
                              const std::set<std::string> &extra,
                              bool recursive,
-                             const PathMatch& ignored,
+                             PathMatch& ignored,
                              bool debug)
 {
     if (ignored.match(path))
@@ -280,7 +280,7 @@ static std::string addFiles2(std::list<FileWithDetails> &files,
     return "";
 }
 
-std::string FileLister::addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, const PathMatch& ignored, bool debug)
+std::string FileLister::addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, PathMatch& ignored, bool debug)
 {
     if (path.empty())
         return "no path specified";
@@ -304,7 +304,7 @@ std::string FileLister::addFiles(std::list<FileWithDetails> &files, const std::s
 
 #endif
 
-std::string FileLister::recursiveAddFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, const PathMatch& ignored, bool debug)
+std::string FileLister::recursiveAddFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, PathMatch& ignored, bool debug)
 {
     return addFiles(files, path, extra, true, ignored, debug);
 }

cli/filelister.h

@@ -44,7 +44,7 @@ class FileLister {
      * @param debug log if path was ignored
      * @return On success, an empty string is returned. On error, a error message is returned.
      */
-    static std::string recursiveAddFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, const PathMatch& ignored, bool debug = false);
+    static std::string recursiveAddFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, PathMatch& ignored, bool debug = false);
 
     /**
      * @brief (Recursively) add source files to a map.
@@ -59,7 +59,7 @@ class FileLister {
      * @param debug log when a path was ignored
      * @return On success, an empty string is returned. On error, a error message is returned.
      */
-    static std::string addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, const PathMatch& ignored, bool debug = false);
+    static std::string addFiles(std::list<FileWithDetails> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, PathMatch& ignored, bool debug = false);
 };
 
 /// @}

gui/filelist.cpp

@@ -100,7 +100,14 @@ QStringList FileList::getFileList() const
         }
         return names;
     }
-    return applyExcludeList();
+    QStringList unmatched;
+    return applyExcludeList(unmatched);
+}
+
+QStringList FileList::getUnmatchedExcludes() const {
+    QStringList unmatched;
+    (void)applyExcludeList(unmatched);
+    return unmatched;
 }
 
 void FileList::addExcludeList(const QStringList &paths)
@@ -117,9 +124,9 @@ static std::vector<std::string> toStdStringList(const QStringList &stringList)
     return ret;
 }
 
-QStringList FileList::applyExcludeList() const
+QStringList FileList::applyExcludeList(QStringList& unmatched) const
 {
-    const PathMatch pathMatch(toStdStringList(mExcludedPaths), QDir::currentPath().toStdString());
+    PathMatch pathMatch(toStdStringList(mExcludedPaths), QDir::currentPath().toStdString());
 
     QStringList paths;
     for (const QFileInfo& item : mFileList) {
@@ -129,5 +136,10 @@ QStringList FileList::applyExcludeList() const
         if (!pathMatch.match(canonical.toStdString()))
             paths << canonical;
     }
+
+    for (const std::string& excludePath: pathMatch.unmatched()) {
+        unmatched << QString::fromStdString(excludePath);
+    }
+
     return paths;
 }

gui/filelist.h

@@ -24,6 +24,8 @@
 #include <QString>
 #include <QStringList>
 
+class PathMatch;
+
 /**
  * @brief A class for listing files and directories to check.
  * This class creates a list of files to check. If directory name is given then
@@ -64,6 +66,12 @@ class FileList {
      */
     QStringList getFileList() const;
 
+    /**
+     * @brief Return list of unmatched excludes
+     * @return list of unmatched excludes
+     */
+    QStringList getUnmatchedExcludes() const;
+
     /**
      * @brief Add list of paths to exclusion list.
      * @param paths Paths to exclude.
@@ -89,9 +97,10 @@ class FileList {
      * This method takes the list of paths and applies the exclude lists to
      * it. And then returns the list of paths that did not match the
      * exclude filters.
+     * @param unmatched output of unmatched exclude paths
      * @return Filtered list of paths.
      */
-    QStringList applyExcludeList() const;
+    QStringList applyExcludeList(QStringList& unmatched) const;
 
 private:
     QFileInfoList mFileList;

gui/mainwindow.cpp

@@ -647,7 +647,7 @@ void MainWindow::doAnalyzeProject(ImportProject p, const bool checkLib, const bo
     mUI->mResults->setCheckSettings(checkSettings);
 }
 
-void MainWindow::doAnalyzeFiles(const QStringList &files, const bool checkLib, const bool checkConfig)
+void MainWindow::doAnalyzeFiles(const QStringList &files, const bool checkLib, const bool checkConfig, const bool checkUnusedExcludes)
 {
     if (files.isEmpty())
         return;
@@ -683,6 +683,17 @@ void MainWindow::doAnalyzeFiles(const QStringList &files, const bool checkLib, c
         return;
     }
 
+    const QStringList& unmatchedExcludePaths = checkUnusedExcludes ? pathList.getUnmatchedExcludes() : QStringList();
+    if (!unmatchedExcludePaths.isEmpty()) {
+        QMessageBox msg(QMessageBox::Warning,
+                        "Cppcheck",
+                        tr("Unused exclude paths:\n%1\nto hide warnings in certain files use suppressions instead").arg(unmatchedExcludePaths.join("\n")),
+                        QMessageBox::Ok,
+                        this);
+        msg.exec();
+        return;
+    }
+
     std::list<FileWithDetails> fdetails = enrichFilesForAnalysis(fileNames, checkSettings);
 
     // TODO: lock UI here?
@@ -1981,7 +1992,9 @@ void MainWindow::analyzeProject(const ProjectFile *projectFile, const QStringLis
     if (paths.isEmpty()) {
         paths << mCurrentDirectory;
     }
-    doAnalyzeFiles(paths, checkLib, checkConfig);
+    // the exclude paths can only be validated when the whole project is analyzed
+    const bool checkUnusedExcludes = recheckFiles.isEmpty();
+    doAnalyzeFiles(paths, checkLib, checkConfig, checkUnusedExcludes);
 }
 
 void MainWindow::newProjectFile()

gui/mainwindow.h

@@ -317,8 +317,9 @@ private slots:
      * @param files List of files and/or directories to analyze
      * @param checkLib Flag to indicate if library should be checked
      * @param checkConfig Flag to indicate if the configuration should be checked.
+     * @param checkUnusedExcludes Flag to indicate if unused exclude paths should be reported.
      */
-    void doAnalyzeFiles(const QStringList &files, bool checkLib = false, bool checkConfig = false);
+    void doAnalyzeFiles(const QStringList &files, bool checkLib = false, bool checkConfig = false, bool checkUnusedExcludes = false);
 
     /**
      * @brief Get our default cppcheck settings and read project file.

gui/test/filelist/testfilelist.cpp

@@ -184,4 +184,39 @@ void TestFileList::filterFiles5() const
     QVERIFY(!files.contains(base + "/dir1/dir11/foo11.cpp"));
 }
 
+void TestFileList::unmatchedExcludes1() const
+{
+    FileList list;
+    QStringList filters;
+    filters << "foo1.cpp" << "foo3.cc";
+    list.addExcludeList(filters);
+    list.addDirectory(QString(SRCDIR) + "/../data/files");
+    QVERIFY(list.getUnmatchedExcludes().isEmpty());
+}
+
+void TestFileList::unmatchedExcludes2() const
+{
+    FileList list;
+    QStringList filters;
+    filters << "foo1.cpp" << "bar.cpp" << "dir3/";
+    list.addExcludeList(filters);
+    list.addDirectory(QString(SRCDIR) + "/../data/files", true);
+    const QStringList unmatched = list.getUnmatchedExcludes();
+    QCOMPARE(unmatched.size(), 2);
+    QCOMPARE(unmatched[0], QString("bar.cpp"));
+    QCOMPARE(unmatched[1], QString("dir3/"));
+    // unmatched excludes does not affect the file list
+    QCOMPARE(list.getFileList().size(), 9);
+}
+
+void TestFileList::unmatchedExcludes3() const
+{
+    FileList list;
+    QStringList filters;
+    filters << "dir1/";
+    list.addExcludeList(filters);
+    list.addDirectory(QString(SRCDIR) + "/../data/files", true);
+    QVERIFY(list.getUnmatchedExcludes().isEmpty());
+}
+
 QTEST_MAIN(TestFileList)

gui/test/filelist/testfilelist.h

@@ -33,4 +33,7 @@ private slots:
     void filterFiles3() const;
     void filterFiles4() const;
     void filterFiles5() const;
+    void unmatchedExcludes1() const;
+    void unmatchedExcludes2() const;
+    void unmatchedExcludes3() const;
 };