clang tidy: add header ignore option to include duplicate files

Author: lakshsidhu04

clang-tools-extra/clang-tidy/misc/HeaderIncludeCycleCheck.cpp

@@ -107,7 +107,7 @@ class CyclicDependencyCallbacks : public PPCallbacks {
       Check.diag(Loc, "direct self-inclusion of header file '%0'") << FileName;
       return;
     }
-
+    
     Check.diag(Loc, "circular header file dependency detected while including "
                     "'%0', please check the include path")
         << FileName;

clang-tools-extra/clang-tidy/readability/DuplicateIncludeCheck.cpp

@@ -11,7 +11,12 @@
 #include "clang/Lex/Preprocessor.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/SmallVector.h"
+#include "llvm/Support/Regex.h"
+#include "llvm/Support/Path.h"
+#include "../utils/OptionsUtils.h"
+#include "llvm/ADT/StringExtras.h"
 #include <memory>
+#include <vector>
 
 namespace clang::tidy::readability {
 
@@ -33,12 +38,9 @@ using FileList = SmallVector<StringRef>;
 class DuplicateIncludeCallbacks : public PPCallbacks {
 public:
   DuplicateIncludeCallbacks(DuplicateIncludeCheck &Check,
-                            const SourceManager &SM)
-      : Check(Check), SM(SM) {
-    // The main file doesn't participate in the FileChanged notification.
-    Files.emplace_back();
-  }
-
+                            const SourceManager &SM, 
+                            const std::vector<std::string> &AllowedStrings);
+  
   void FileChanged(SourceLocation Loc, FileChangeReason Reason,
                    SrcMgr::CharacteristicKind FileType,
                    FileID PrevFID) override;
@@ -62,14 +64,28 @@ class DuplicateIncludeCallbacks : public PPCallbacks {
   SmallVector<FileList> Files;
   DuplicateIncludeCheck &Check;
   const SourceManager &SM;
+  std::vector<llvm::Regex> AllowedDuplicateRegex;
+
+  bool IsAllowedDuplicateInclude(StringRef TokenName, OptionalFileEntryRef File,
+                                 StringRef RelativePath);
 };
 
 } // namespace
 
-void DuplicateIncludeCallbacks::FileChanged(SourceLocation Loc,
-                                            FileChangeReason Reason,
-                                            SrcMgr::CharacteristicKind FileType,
-                                            FileID PrevFID) {
+DuplicateIncludeCallbacks::DuplicateIncludeCallbacks(
+    DuplicateIncludeCheck &Check, const SourceManager &SM,
+    const std::vector<std::string> &AllowedStrings) : Check(Check), SM(SM) {
+  // The main file doesn't participate in the FileChanged notification.
+  Files.emplace_back();
+  AllowedDuplicateRegex.reserve(AllowedStrings.size());
+  for (const std::string &str : AllowedStrings) {
+    AllowedDuplicateRegex.emplace_back(str);
+  }
+}
+
+void DuplicateIncludeCallbacks::FileChanged(
+        SourceLocation Loc, FileChangeReason Reason,
+        SrcMgr::CharacteristicKind FileType, FileID PrevFID) {
   if (Reason == EnterFile)
     Files.emplace_back();
   else if (Reason == ExitFile)
@@ -85,6 +101,14 @@ void DuplicateIncludeCallbacks::InclusionDirective(
   if (FilenameRange.getBegin().isMacroID() ||
       FilenameRange.getEnd().isMacroID())
     return;
+  
+  // if duplicate allowed, record and return
+  if(IsAllowedDuplicateInclude(FileName, File, RelativePath))
+  {
+      Files.back().push_back(FileName);
+      return;
+  }
+
   if (llvm::is_contained(Files.back(), FileName)) {
     // We want to delete the entire line, so make sure that [Start,End] covers
     // everything.
@@ -109,9 +133,54 @@ void DuplicateIncludeCallbacks::MacroUndefined(const Token &MacroNameTok,
   Files.back().clear();
 }
 
+bool DuplicateIncludeCallbacks::IsAllowedDuplicateInclude(StringRef TokenName,
+                                                OptionalFileEntryRef File,
+                                                StringRef RelativePath) {
+  SmallVector<StringRef, 3> matchArguments;
+  matchArguments.push_back(TokenName);
+  
+  if (!RelativePath.empty())
+    matchArguments.push_back(llvm::sys::path::filename(RelativePath));
+  
+  if (File) {
+    StringRef RealPath = File->getFileEntry().tryGetRealPathName();
+    if (!RealPath.empty())
+      matchArguments.push_back(llvm::sys::path::filename(RealPath));
+  }
+  
+  // try to match with each regex
+  for (const llvm::Regex &reg : AllowedDuplicateRegex) {
+    for (StringRef arg : matchArguments) {
+      if (reg.match(arg))
+        return true;
+    }
+  }
+  return false;
+}
+
+DuplicateIncludeCheck::DuplicateIncludeCheck(StringRef Name,
+                                             ClangTidyContext *Context)
+    : ClangTidyCheck(Name, Context) {
+  std::string Raw = Options.get("AllowedDuplicateIncludes", "").str();
+  if (!Raw.empty()) {
+    SmallVector<StringRef, 4> StringParts;
+    StringRef(Raw).split(StringParts, ',', -1, false);
+    
+    for (StringRef Part : StringParts) {
+      Part = Part.trim(); 
+      if (!Part.empty())
+        AllowedDuplicateIncludes.push_back(Part.str());
+    }
+  }
+}
+
 void DuplicateIncludeCheck::registerPPCallbacks(
     const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) {
-  PP->addPPCallbacks(std::make_unique<DuplicateIncludeCallbacks>(*this, SM));
+  PP->addPPCallbacks(std::make_unique<DuplicateIncludeCallbacks>(*this, SM, AllowedDuplicateIncludes));
 }
 
+void DuplicateIncludeCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
+  Options.store(Opts, "AllowedDuplicateIncludes",
+                llvm::join(AllowedDuplicateIncludes, ","));
+}
 } // namespace clang::tidy::readability

clang-tools-extra/clang-tidy/readability/DuplicateIncludeCheck.h

@@ -10,7 +10,8 @@
 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_DUPLICATE_INCLUDE_CHECK_H
 
 #include "../ClangTidyCheck.h"
-
+#include <vector>
+#include <string>
 namespace clang::tidy::readability {
 
 /// \brief Find and remove duplicate #include directives.
@@ -19,11 +20,14 @@ namespace clang::tidy::readability {
 /// directives between them are analyzed.
 class DuplicateIncludeCheck : public ClangTidyCheck {
 public:
-  DuplicateIncludeCheck(StringRef Name, ClangTidyContext *Context)
-      : ClangTidyCheck(Name, Context) {}
+  DuplicateIncludeCheck(StringRef Name, ClangTidyContext *Context);
 
   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
                            Preprocessor *ModuleExpanderPP) override;
+  
+  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
+private:
+  std::vector<std::string> AllowedDuplicateIncludes;
 };
 
 } // namespace clang::tidy::readability