Use QuotedHeaders filter in determining inclusion style

Author: Harald-R

clang-tools-extra/clangd/IncludeCleaner.cpp

@@ -118,7 +118,8 @@ bool mayConsiderUnused(const Inclusion &Inc, ParsedAST &AST,
 std::vector<Diag> generateMissingIncludeDiagnostics(
     ParsedAST &AST, llvm::ArrayRef<MissingIncludeDiagInfo> MissingIncludes,
     llvm::StringRef Code, HeaderFilter IgnoreHeaders,
-    HeaderFilter AngledHeaders, const ThreadsafeFS &TFS) {
+    HeaderFilter AngledHeaders, HeaderFilter QuotedHeaders,
+    const ThreadsafeFS &TFS) {
   std::vector<Diag> Result;
   const SourceManager &SM = AST.getSourceManager();
   const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID());
@@ -142,24 +143,37 @@ std::vector<Diag> generateMissingIncludeDiagnostics(
          AST.getPreprocessor().getHeaderSearchInfo(), MainFile});
 
     llvm::StringRef HeaderRef{Spelling};
-    bool Angled = HeaderRef.starts_with("<");
+
+    bool IsAngled = false;
     for (auto &Filter : AngledHeaders) {
       if (Filter(HeaderRef)) {
-        Angled = true;
+        IsAngled = true;
+        break;
+      }
+    }
+    bool IsQuoted = false;
+    for (auto &Filter : QuotedHeaders) {
+      if (Filter(HeaderRef)) {
+        IsQuoted = true;
         break;
       }
     }
+    if (IsAngled == IsQuoted) {
+      IsAngled = HeaderRef.starts_with("<");
+    } else if (!IsAngled && IsQuoted) {
+      IsAngled = false;
+    }
 
     // We might suggest insertion of an existing include in edge cases, e.g.,
     // include is present in a PP-disabled region, or spelling of the header
     // turns out to be the same as one of the unresolved includes in the
     // main file.
     std::optional<tooling::Replacement> Replacement = HeaderIncludes.insert(
-        HeaderRef.trim("\"<>"), Angled, tooling::IncludeDirective::Include);
+        HeaderRef.trim("\"<>"), IsAngled, tooling::IncludeDirective::Include);
     if (!Replacement.has_value())
       continue;
 
-    if (Angled && Spelling.front() == '\"') {
+    if (IsAngled && Spelling.front() == '\"') {
       Spelling.front() = '<';
       Spelling.back() = '>';
     }
@@ -497,14 +511,16 @@ bool isPreferredProvider(const Inclusion &Inc,
 std::vector<Diag> issueIncludeCleanerDiagnostics(
     ParsedAST &AST, llvm::StringRef Code,
     const IncludeCleanerFindings &Findings, const ThreadsafeFS &TFS,
-    HeaderFilter IgnoreHeaders, HeaderFilter AngledHeaders) {
+    HeaderFilter IgnoreHeaders, HeaderFilter AngledHeaders,
+    HeaderFilter QuotedHeaders) {
   trace::Span Tracer("IncludeCleaner::issueIncludeCleanerDiagnostics");
   std::vector<Diag> UnusedIncludes = generateUnusedIncludeDiagnostics(
       AST.tuPath(), Findings.UnusedIncludes, Code, IgnoreHeaders);
   std::optional<Fix> RemoveAllUnused = removeAllUnusedIncludes(UnusedIncludes);
 
   std::vector<Diag> MissingIncludeDiags = generateMissingIncludeDiagnostics(
-      AST, Findings.MissingIncludes, Code, IgnoreHeaders, AngledHeaders, TFS);
+      AST, Findings.MissingIncludes, Code, IgnoreHeaders, AngledHeaders,
+      QuotedHeaders, TFS);
   std::optional<Fix> AddAllMissing = addAllMissingIncludes(MissingIncludeDiags);
 
   std::optional<Fix> FixAll;

clang-tools-extra/clangd/IncludeCleaner.h

@@ -60,7 +60,8 @@ computeIncludeCleanerFindings(ParsedAST &AST,
 std::vector<Diag> issueIncludeCleanerDiagnostics(
     ParsedAST &AST, llvm::StringRef Code,
     const IncludeCleanerFindings &Findings, const ThreadsafeFS &TFS,
-    HeaderFilter IgnoreHeader = {}, HeaderFilter AngledHeaders = {});
+    HeaderFilter IgnoreHeader = {}, HeaderFilter AngledHeaders = {},
+    HeaderFilter QuotedHeaders = {});
 
 /// Converts the clangd include representation to include-cleaner
 /// include representation.

clang-tools-extra/clangd/ParsedAST.cpp

@@ -381,9 +381,9 @@ std::vector<Diag> getIncludeCleanerDiags(ParsedAST &AST, llvm::StringRef Code,
     Findings.MissingIncludes.clear();
   if (SuppressUnused)
     Findings.UnusedIncludes.clear();
-  return issueIncludeCleanerDiagnostics(AST, Code, Findings, TFS,
-                                        Cfg.Diagnostics.Includes.IgnoreHeader,
-                                        Cfg.Style.AngledHeaders);
+  return issueIncludeCleanerDiagnostics(
+      AST, Code, Findings, TFS, Cfg.Diagnostics.Includes.IgnoreHeader,
+      Cfg.Style.AngledHeaders, Cfg.Style.QuotedHeaders);
 }
 
 tidy::ClangTidyCheckFactories

clang-tools-extra/clangd/unittests/IncludeCleanerTests.cpp

@@ -226,7 +226,8 @@ TEST(IncludeCleaner, GenerateMissingHeaderDiags) {
 #include "dir/c.h"
 $insert_d[[]]$insert_foo[[]]#include "fuzz.h"
 #include "header.h"
-$insert_foobar[[]]$insert_angled[[]]#include <e.h>
+$insert_foobar[[]]$insert_quoted[[]]#include "quoted_wrapper.h"
+$insert_angled[[]]#include <e.h>
 $insert_f[[]]$insert_vector[[]]
 
 #define DEF(X) const Foo *X;
@@ -239,6 +240,7 @@ TEST(IncludeCleaner, GenerateMissingHeaderDiags) {
   void foo() {
     $b[[b]]();
     $angled[[angled]]();
+    $quoted[[quoted]]();
 
     ns::$bar[[Bar]] bar;
     bar.d();
@@ -269,6 +271,9 @@ TEST(IncludeCleaner, GenerateMissingHeaderDiags) {
   TU.AdditionalFiles["angled.h"] = guard("void angled();");
   TU.ExtraArgs.push_back("-I" + testPath("."));
 
+  TU.AdditionalFiles["quoted_wrapper.h"] = guard("#include \"quoted.h\"");
+  TU.AdditionalFiles["quoted.h"] = guard("void quoted();");
+
   TU.AdditionalFiles["dir/c.h"] = guard("#include \"d.h\"");
   TU.AdditionalFiles["dir/d.h"] =
       guard("namespace ns { struct Bar { void d(); }; }");
@@ -308,6 +313,9 @@ TEST(IncludeCleaner, GenerateMissingHeaderDiags) {
       }},
       /*AngledHeaders=*/{[](llvm::StringRef Header) {
         return Header.contains("angled.h");
+      }},
+      /*QuotedHeaders=*/{[](llvm::StringRef Header) {
+        return Header.contains("quoted.h");
       }});
   EXPECT_THAT(
       Diags,
@@ -322,6 +330,12 @@ TEST(IncludeCleaner, GenerateMissingHeaderDiags) {
                 withFix({Fix(MainFile.range("insert_angled"),
                              "#include <angled.h>\n", "#include <angled.h>"),
                          FixMessage("add all missing includes")})),
+          AllOf(
+              Diag(MainFile.range("quoted"),
+                   "No header providing \"quoted\" is directly included"),
+              withFix({Fix(MainFile.range("insert_quoted"),
+                           "#include \"quoted.h\"\n", "#include \"quoted.h\""),
+                       FixMessage("add all missing includes")})),
           AllOf(Diag(MainFile.range("bar"),
                      "No header providing \"ns::Bar\" is directly included"),
                 withFix({Fix(MainFile.range("insert_d"),