[clangd] Support iwyu pragma: no_include

[zyounan]

Summary

This patch is one of the steps trying to optimize experience
of header insertion in code completion.
IWYU supports no_include pragma that helps user to get rid
of specified headers in main file.
The patch consists of two parts: Code completion part that
prevent auto insertion if the header to be inserted is under
the guard of no_include pragma. The other part is for include
cleaner, which emits diagnostic message pointing out that user
is including no_include headers.

A possible workaround for clangd/clangd#1481.

[zyounan]

Remove extra headers

[zyounan]

Update test

[zyounan]

Update tests && Use Preprocessor.LookupFile

[zyounan]

Fix test on windows

[zyounan]

Ping

[kadircet]

thanks a lot for the patch!

we're migrating IWYU related functionality in clangd to make use of include-cleaner library nowadays. so can you actually move the IWYU no_include pragma handling logic into https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/include-cleaner/lib/Record.cpp?
This won't have affect on clangd regarding the particular problem you're facing immediately, but we're going to merge the logic inside include-cleaner and clangd soon and such discrepancies should disappear then.

in the meanwhile regarding the particular problem you're facing for experimental symbols. sorry for shutting down D142836, but that actually made us re-evaluate the approach of hand-curated lists and we've decided to introduce such mappings. so if you can revamp D142836 and put TsStdSymbolMap.inc in https://github.com/llvm/llvm-project/tree/main/clang/lib/Tooling/Inclusions/Stdlib/StdTsSymbolMap.inc we can land it and make sure it work as intended inside clangd, even before we merge the IWYU pragma handling logic. Happy to do that myself if you don't feel like doing it, sorry for creating some confusion here :(

[zyounan]

In D143319#4115186, @kadircet wrote:

thanks a lot for the patch!

we're migrating IWYU related functionality in clangd to make use of include-cleaner library nowadays. so can you actually move the IWYU no_include pragma handling logic into https://github.com/llvm/llvm-project/blob/main/clang-tools-extra/include-cleaner/lib/Record.cpp?
This won't have affect on clangd regarding the particular problem you're facing immediately, but we're going to merge the logic inside include-cleaner and clangd soon and such discrepancies should disappear then.

in the meanwhile regarding the particular problem you're facing for experimental symbols. sorry for shutting down D142836, but that actually made us re-evaluate the approach of hand-curated lists and we've decided to introduce such mappings. so if you can revamp D142836 and put TsStdSymbolMap.inc in https://github.com/llvm/llvm-project/tree/main/clang/lib/Tooling/Inclusions/Stdlib/StdTsSymbolMap.inc we can land it and make sure it work as intended inside clangd, even before we merge the IWYU pragma handling logic. Happy to do that myself if you don't feel like doing it, sorry for creating some confusion here :(

Although I'm convinced that they're not stable enough to migrate into Stdlib directory, I'm still glad to hear that we're going to support TS symbols.
And certainly, I'd love to revamp D142836, while I believe that this IWYU no-include is a more general approach than that ad-hoc way.

[zyounan]

Sorry for the late update :)
Move parsing logic to Record.cpp now.

[hokein]

Thanks for the patch, and sorry for the long delay.

You probably need to do a large rebase when updating this patch (since the include-cleaner clangd code has been changed a lot)

This is a big patch, touching several pieces (I'd suggest split this patch, and narrow its scope.):

1. support no_include pragma in include-cleaner library (I made some comments regarding the implementation)
2. usage of no_include pragma:
   • 2.1 include-cleaner diagnostics in clangd -- for missing-includes, we should not insert a spelled include when it is in the NoIncludeSet;
   • 2.2 global code completion respects no_include pragma

It makes sense to support 1 and 2.1. And 2.2 is nice to have -- global code completion was built long time ago, and we haven't heard of any user complains, I'm less certain, it is probably fine if it is trivial to implement.

clang-tools-extra/clangd/IncludeCleaner.cpp

579

I'm not sure it is worth to make a dedicated function for this marginal pragma, I think we can treat it as an unused-include case, and we can move it to issueUnusedIncludesDiagnostics.

clang-tools-extra/include-cleaner/include/clang-include-cleaner/Record.h

44 ↗

(On Diff #499417)

I think we can do it simpler. The Resolved field is no used anywhere, and is expensive to get.

The critical information to store is the header spelled in the no_include pragma, so having a StringSet<> NoIncludes field in PragmaIncludes should be sufficient.

165 ↗

(On Diff #499417)

This is not a specific issue for no_include pragma, it is a known limitation -- ideally we should make PragmaIncludes collect all IWYU pragmas outside of the preamble region, tracking in https://github.com/clangd/clangd/issues/1571.
I think we should merge this logic to the PragmaIncludes structure.

clang-tools-extra/clangd/CodeComplete.cpp

auto RecorderOwner = std::make_unique<CompletionRecorder>(Opts, [&]() {
       // If preprocessor was run, inclusions from preprocessor callback should
       // already be added to Includes.
       Inserter.emplace(
           SemaCCInput.FileName, SemaCCInput.ParseInput.Contents, Style,
           SemaCCInput.ParseInput.CompileCommand.Directory,
           &Recorder->CCSema->getPreprocessor().getHeaderSearchInfo());
       for (const auto &Inc : Includes.MainFileIncludes)
         Inserter->addExisting(Inc);
+      if (Includes.IwyuNoIncludes) {
+        for (const auto &Inc : *Includes.IwyuNoIncludes)
+          Inserter->addNoInclude(Inc);
+      }
 
       // Most of the cost of file proximity is in initializing the FileDistance
       // structures based on the observed includes, once per query. Conceptually
       // that happens here (though the per-URI-scheme initialization is lazy).
       // The per-result proximity scoring is (amortized) very cheap.
       FileDistanceOptions ProxOpts{}; // Use defaults.
       const auto &SM = Recorder->CCSema->getSourceManager();
       llvm::StringMap<SourceParams> ProxSources;

clang-tools-extra/clangd/Headers.h

struct Inclusion {
   int HashLine = 0;        // Line number containing the directive, 0-indexed.
   SrcMgr::CharacteristicKind FileKind = SrcMgr::C_User;
   std::optional<unsigned> HeaderID;
   bool BehindPragmaKeep = false; // Has IWYU pragma: keep right after.
 };
 llvm::raw_ostream &operator<<(llvm::raw_ostream &, const Inclusion &);
 bool operator==(const Inclusion &LHS, const Inclusion &RHS);
 
+struct IwyuNoInclude {
+  std::string
+      Written;   // For `IWYU pragma no_include <vector>`, it is `<vector>`.
+  Path Resolved; // Resolved path to written file.
+  int HashLine;  // 0-based line number containing IWYU pragma
+  IwyuNoInclude() = default;
+  IwyuNoInclude(std::string Written, Path Resolved, int HashLine)
+      : Written(std::move(Written)), Resolved(std::move(Resolved)),
+        HashLine(HashLine) {}
+  friend bool operator<(const IwyuNoInclude &LHS, const IwyuNoInclude &RHS);
+};
+
 // Contains information about one file in the build graph and its direct
 // dependencies. Doesn't own the strings it references (IncludeGraph is
 // self-contained).
 struct IncludeGraphNode {
   enum class SourceFlag : uint8_t {
     None = 0,
     // Whether current file is a main file rather than a header.
     IsTU = 1 << 0,
public:
 
   // Maps HeaderID to the ids of the files included from it.
   llvm::DenseMap<HeaderID, SmallVector<HeaderID>> IncludeChildren;
 
   llvm::DenseMap<tooling::stdlib::Header, llvm::SmallVector<HeaderID>>
       StdlibHeaders;
 
   std::vector<Inclusion> MainFileIncludes;
+  std::optional<std::set<IwyuNoInclude>>
+      IwyuNoIncludes; // IWYU pragma: no_include
 
   // We reserve HeaderID(0) for the main file and will manually check for that
   // in getID and getOrCreateID because the UniqueID is not stable when the
   // content of the main file changes.
   static const HeaderID MainFileID = HeaderID(0u);
 
   class RecordHeaders;
 
IncludeInserter(StringRef FileName, StringRef Code,
                   const format::FormatStyle &Style, StringRef BuildDir,
                   HeaderSearch *HeaderSearchInfo)
       : FileName(FileName), Code(Code), BuildDir(BuildDir),
         HeaderSearchInfo(HeaderSearchInfo),
         Inserter(FileName, Code, Style.IncludeStyle) {}
 
   void addExisting(const Inclusion &Inc);
 
+  void addNoInclude(const IwyuNoInclude &Inc);
+
   /// Checks whether to add an #include of the header into \p File.
   /// An #include will not be added if:
   ///   - Either \p DeclaringHeader or \p InsertedHeader is already (directly)
   ///   in \p Inclusions (including those included via different paths).
   ///   - \p DeclaringHeader or \p InsertedHeader is the same as \p File.
   ///
   /// \param DeclaringHeader is path of the original header corresponding to \p
   /// InsertedHeader e.g. the header that declares a symbol.
std::optional<TextEdit> insert(llvm::StringRef VerbatimHeader,
                                  tooling::IncludeDirective Directive) const;
 
 private:
   StringRef FileName;
   StringRef Code;
   StringRef BuildDir;
   HeaderSearch *HeaderSearchInfo = nullptr;
   llvm::StringSet<> IncludedHeaders; // Both written and resolved.
-  tooling::HeaderIncludes Inserter;  // Computers insertion replacement.
+  llvm::StringSet<> IwyuNoIncludeHeaders; // Iwyu: no_include headers, with
+                                          // written and resolved.
+  tooling::HeaderIncludes Inserter;       // Computers insertion replacement.
 };
 
 } // namespace clangd
 } // namespace clang
 
 namespace llvm {
 
 // Support HeaderIDs as DenseMap keys.

clang-tools-extra/clangd/Headers.cpp

 //===--- Headers.cpp - Include headers ---------------------------*- C++-*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "Headers.h"
 #include "Preamble.h"
 #include "SourceCode.h"
+#include "support/Logger.h"
 #include "clang/Basic/SourceLocation.h"
 #include "clang/Basic/SourceManager.h"
 #include "clang/Frontend/CompilerInstance.h"
 #include "clang/Lex/HeaderSearch.h"
 #include "clang/Lex/PPCallbacks.h"
 #include "clang/Lex/Preprocessor.h"
 #include "clang/Tooling/Inclusions/HeaderAnalysis.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/Support/Path.h"
+#include <chrono>
 #include <cstring>
 #include <optional>
 
 namespace clang {
 namespace clangd {
 
 class IncludeStructure::RecordHeaders : public PPCallbacks,
                                         public CommentHandler {
if (inMainFile()) {
       // 2. handleCommentInMainFile("// IWYU pragma: keep")
       // 3. InclusionDirective("bar.h")
       //
       // This code stores the last location of "IWYU pragma: keep" (or export)
       // comment in the main file, so that when InclusionDirective is called, it
       // will know that the next inclusion is behind the IWYU pragma.
       // FIXME: Support "IWYU pragma: begin_exports" and "IWYU pragma:
       // end_exports".
-      if (!Pragma->startswith("export") && !Pragma->startswith("keep"))
-        return false;
       unsigned Offset = SM.getFileOffset(Range.getBegin());
-      LastPragmaKeepInMainFileLine =
+      const unsigned CurrentLine =
           SM.getLineNumber(SM.getMainFileID(), Offset) - 1;
+      if (Pragma->startswith("export") || Pragma->startswith("keep"))
+        LastPragmaKeepInMainFileLine = CurrentLine;
+      else if (Pragma->consume_front("no_include")) {
+        auto &NI = Out->IwyuNoIncludes;
+        if (!NI)
+          NI.emplace();
+        auto Spelling =
+            Pragma->take_until([](char C) { return C == '\n'; }).trim();
+        if (Spelling.empty())
+          return false;
+        if (!(Spelling.front() == '<' && Spelling.back() == '>') &&
+            !(Spelling.front() == '"' && Spelling.back() == '"'))
+          return false;
+        if (auto MaybeHeader = Spelling.trim("\"<>"); !MaybeHeader.empty()) {
+          SmallVector<std::pair<const FileEntry *, const DirectoryEntry *>, 1>
+              Includers;
+          const auto FE = HeaderInfo.LookupFile(
+              /*Filename=*/MaybeHeader,
+              /*IncludeLoc=*/{}, /*isAngled=*/Spelling.starts_with("<"),
+              /*FromDir=*/nullptr, /*CurDir=*/nullptr,
+              /*Includers=*/Includers, /*SearchPath=*/nullptr,
+              /*RelativePath=*/nullptr, /*RequestingModule=*/nullptr,
+              /*SuggestedModule=*/nullptr, /*IsMapped=*/nullptr,
+              /*IsFrameworkFound=*/nullptr,
+              /*SkipCache=*/false, /*BuildSystemModule=*/false,
+              /*OpenFile=*/false, /*CacheFailures=*/false);
+          NI->insert(IwyuNoInclude(
+              /*Written=*/Spelling.str(),
+              /*Resolved=*/
+              !FE ? "" : FE->getFileEntry().tryGetRealPathName().str(),
+              CurrentLine));
+        }
+        return false;
+      }
     } else {
       // Memorize headers that have export pragmas in them. Include Cleaner
       // does not support them properly yet, so they will be not marked as
       // unused.
       // FIXME: Once IncludeCleaner supports export pragmas, remove this.
       if (!Pragma->startswith("export") && !Pragma->startswith("begin_exports"))
         return false;
       Out->HasIWYUExport.insert(

 }
 
 void IncludeInserter::addExisting(const Inclusion &Inc) {
   IncludedHeaders.insert(Inc.Written);
   if (!Inc.Resolved.empty())
     IncludedHeaders.insert(Inc.Resolved);
 }
 
+void IncludeInserter::addNoInclude(const IwyuNoInclude &Inc) {
+  IwyuNoIncludeHeaders.insert(Inc.Written);
+  if (!Inc.Resolved.empty())
+    IwyuNoIncludeHeaders.insert(Inc.Resolved);
+}
+
 /// FIXME(ioeric): we might not want to insert an absolute include path if the
 /// path is not shortened.
 bool IncludeInserter::shouldInsertInclude(
     PathRef DeclaringHeader, const HeaderFile &InsertedHeader) const {
   assert(InsertedHeader.valid());
   if (!HeaderSearchInfo && !InsertedHeader.Verbatim)
     return false;
   if (FileName == DeclaringHeader || FileName == InsertedHeader.File)
     return false;
   auto Included = [&](llvm::StringRef Header) {
     return IncludedHeaders.find(Header) != IncludedHeaders.end();
   };
-  return !Included(DeclaringHeader) && !Included(InsertedHeader.File);
+  auto IsIwyuNoInclude = [&](llvm::StringRef Header) {
+    return IwyuNoIncludeHeaders.find(Header) != IwyuNoIncludeHeaders.end();
+  };
+  auto ShouldInsert = [&](auto &Predicate) {
+    return !Predicate(DeclaringHeader) && !Predicate(InsertedHeader.File);
+  };
+  return ShouldInsert(Included) && ShouldInsert(IsIwyuNoInclude);
 }
 
 std::optional<std::string>
 IncludeInserter::calculateIncludePath(const HeaderFile &InsertedHeader,
                                       llvm::StringRef IncludingFile) const {
   assert(InsertedHeader.valid());
   if (InsertedHeader.Verbatim)
     return InsertedHeader.File;

 
 bool operator==(const Inclusion &LHS, const Inclusion &RHS) {
   return std::tie(LHS.Directive, LHS.FileKind, LHS.HashOffset, LHS.HashLine,
                   LHS.Resolved, LHS.Written) ==
          std::tie(RHS.Directive, RHS.FileKind, RHS.HashOffset, RHS.HashLine,
                   RHS.Resolved, RHS.Written);
 }
 
+bool operator<(const IwyuNoInclude &LHS, const IwyuNoInclude &RHS) {
+  // We want only 1 pragma for the same header.
+  return LHS.Written < RHS.Written;
+}
+
 } // namespace clangd
 } // namespace clang

clang-tools-extra/clangd/IncludeCleaner.h

 // The same as computeUnusedIncludes, but it is an experimental and
 // include-cleaner-lib-based implementation.
 std::vector<const Inclusion *>
 computeUnusedIncludesExperimental(ParsedAST &AST);
 
 std::vector<Diag> issueUnusedIncludesDiagnostics(ParsedAST &AST,
                                                  llvm::StringRef Code);
 
+std::vector<Diag> issueNoIncludesDiagnostics(ParsedAST &AST,
+                                             llvm::StringRef Code);
+
 /// Affects whether standard library includes should be considered for
 /// removal. This is off by default for now due to implementation limitations:
 /// - macros are not tracked
 /// - symbol names without a unique associated header are not tracked
 /// - references to std-namespaced C types are not properly tracked:
 ///   instead of std::size_t -> <cstddef> we see ::size_t -> <stddef.h>
 /// FIXME: remove this hack once the implementation is good enough.
 void setIncludeCleanerAnalyzesStdlib(bool B);
 
 } // namespace clangd
 } // namespace clang
 
 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_INCLUDECLEANER_H

clang-tools-extra/clangd/IncludeCleaner.cpp

for (const auto *Inc : UnusedIncludes) {
     D.Fixes.back().Edits.back().range.start.line = Inc->HashLine;
     D.Fixes.back().Edits.back().range.end.line = Inc->HashLine + 1;
     D.InsideMainFile = true;
     Result.push_back(std::move(D));
   }
   return Result;
 }
 
+std::vector<Diag> issueNoIncludesDiagnostics(ParsedAST &AST,
+                                             llvm::StringRef Code) {
+  // C/C++ only
+  if (AST.getLangOpts().ObjC)
+    return {};
+  std::vector<Diag> Result;
+  std::string FileName =
+      AST.getSourceManager()
+          .getFileEntryRefForID(AST.getSourceManager().getMainFileID())
+          ->getName()
+          .str();
+  auto &IS = AST.getIncludeStructure();
+  auto &NoIncludes = IS.IwyuNoIncludes;
+  if (!NoIncludes)
+    return Result;
+  for (auto &Inc : IS.MainFileIncludes) {
+    const auto It = NoIncludes->find(
+        IwyuNoInclude(Inc.Written, Inc.Resolved, Inc.HashLine));
+    if (It == NoIncludes->end())
+      continue;
+    Diag D;
+    D.Message = llvm::formatv(
+        "included header '{0}' is marked as `no_include` at line {1}",
+        StringRef(Inc.Written).trim("<>\""), It->HashLine + 1);
+    D.Name = "no-include-headers";
+    D.Source = Diag::DiagSource::Clangd;
+    D.File = FileName;
+    D.Severity = DiagnosticsEngine::Warning;
+    D.Tags.push_back(Unnecessary);
+    D.Range = getDiagnosticRange(Code, Inc.HashOffset);
+    D.Fixes.emplace_back();
+    D.Fixes.back().Message = "remove #include directive";
+    D.Fixes.back().Edits.emplace_back();
+    D.Fixes.back().Edits.back().range.start.line = Inc.HashLine;
+    D.Fixes.back().Edits.back().range.end.line = Inc.HashLine + 1;
+    D.InsideMainFile = true;
+    Result.push_back(std::move(D));
+  }
+  return Result;
+}
+
 } // namespace clangd
 } // namespace clang

clang-tools-extra/clangd/ParsedAST.cpp

if (Inputs.Index && !BuildDir.getError()) {
       auto Inserter = std::make_shared<IncludeInserter>(
           Filename, Inputs.Contents, Style, BuildDir.get(),
           &Clang->getPreprocessor().getHeaderSearchInfo());
       ArrayRef<Inclusion> MainFileIncludes;
       if (Preamble) {
         MainFileIncludes = Preamble->Includes.MainFileIncludes;
         for (const auto &Inc : Preamble->Includes.MainFileIncludes)
           Inserter->addExisting(Inc);
+        if (Preamble->Includes.IwyuNoIncludes) {
+          for (const auto &NoInc : *Preamble->Includes.IwyuNoIncludes)
+            Inserter->addNoInclude(NoInc);
+        }
       }
       // FIXME: Consider piping through ASTSignals to fetch this to handle the
       // case where a header file contains ObjC decls but no #imports.
       Symbol::IncludeDirective Directive =
           Inputs.Opts.ImportInsertions
               ? preferredIncludeDirective(Filename, Clang->getLangOpts(),
                                           MainFileIncludes, {})
               : Symbol::Include;
ParsedAST::build(llvm::StringRef Filename, const ParseInputs &Inputs,
   ParsedAST Result(Filename, Inputs.Version, std::move(Preamble),
                    std::move(Clang), std::move(Action), std::move(Tokens),
                    std::move(Macros), std::move(Marks), std::move(ParsedDecls),
                    std::move(Diags), std::move(Includes),
                    std::move(CanonIncludes));
   if (Result.Diags) {
     auto UnusedHeadersDiags =
         issueUnusedIncludesDiagnostics(Result, Inputs.Contents);
+    auto NoIncludeHeadersDiags =
+        issueNoIncludesDiagnostics(Result, Inputs.Contents);
     Result.Diags->insert(Result.Diags->end(),
                          make_move_iterator(UnusedHeadersDiags.begin()),
                          make_move_iterator(UnusedHeadersDiags.end()));
+    Result.Diags->insert(Result.Diags->end(),
+                         make_move_iterator(NoIncludeHeadersDiags.begin()),
+                         make_move_iterator(NoIncludeHeadersDiags.end()));
   }
   return std::move(Result);
 }
 
 ParsedAST::ParsedAST(ParsedAST &&Other) = default;
 
 ParsedAST &ParsedAST::operator=(ParsedAST &&Other) = default;
 

clang-tools-extra/clangd/index/CanonicalIncludes.h

 ///      Not incrementally useful as we support private.
 ///    * Points to a private header without pragmas (rare). This is a reversed
 ///      private pragma, and is valuable but too rare to be worthwhile.
 /// - no_include: this is about as common as private, but only affects the
 ///   current file, so the value is smaller. We could add support.
 /// - friend: this is less common than private, has implementation difficulties,
 ///   and affects behavior in a limited scope.
 /// - associated: extremely rare
+/// Note that support for some other IWYU pragmas (export, keep, no_include...)
+/// are implemented in IncludeStructure.
 std::unique_ptr<CommentHandler>
 collectIWYUHeaderMaps(CanonicalIncludes *Includes);
 
 } // namespace clangd
 } // namespace clang
 
 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_CANONICALINCLUDES_H

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

IncludeStructure collectIncludes() {
     EXPECT_FALSE(Action.Execute());
     Action.EndSourceFile();
     return Includes;
   }
 
   // Calculates the include path, or returns "" on error or header should not be
   // inserted.
   std::string calculate(PathRef Original, PathRef Preferred = "",
-                        const std::vector<Inclusion> &Inclusions = {}) {
+                        const std::vector<Inclusion> &Inclusions = {},
+                        const std::vector<IwyuNoInclude> &IwyuNoIncludes = {}) {
     Clang = setupClang();
     PreprocessOnlyAction Action;
     EXPECT_TRUE(
         Action.BeginSourceFile(*Clang, Clang->getFrontendOpts().Inputs[0]));
 
     if (Preferred.empty())
       Preferred = Original;
     auto ToHeaderFile = [](llvm::StringRef Header) {
       return HeaderFile{std::string(Header),
                         /*Verbatim=*/!llvm::sys::path::is_absolute(Header)};
     };
 
     IncludeInserter Inserter(MainFile, /*Code=*/"", format::getLLVMStyle(),
                              CDB.getCompileCommand(MainFile)->Directory,
                              &Clang->getPreprocessor().getHeaderSearchInfo());
     for (const auto &Inc : Inclusions)
       Inserter.addExisting(Inc);
+    for (const auto &Inc : IwyuNoIncludes)
+      Inserter.addNoInclude(Inc);
     auto Inserted = ToHeaderFile(Preferred);
     if (!Inserter.shouldInsertInclude(Original, Inserted))
       return "";
     auto Path = Inserter.calculateIncludePath(Inserted, MainFile);
     Action.EndSourceFile();
     return Path.value_or("");
   }
 

 )cpp";
 
   EXPECT_THAT(
       collectIncludes().MainFileIncludes,
       UnorderedElementsAre(AllOf(written("\"foo.h\""), hasPragmaKeep(false)),
                            AllOf(written("\"bar.h\""), hasPragmaKeep(true))));
 }
 
+TEST_F(HeadersTest, IWYUPragmaNoInclude) {
+  FS.Files[MainFile] = R"cpp(
+    // IWYU pragma: no_include "baz.h"
+    #include "foo.h"
+    // IWYU pragma: no_include <bar.h>
+    // IWYU pragma: no_include <multiple> "headers.hpp" invalid
+    // IWYU pragma: no_include no_quotes are considered invalid
+    // IWYU pragma: no_include <valid>
+  )cpp";
+  FS.Files["foo.h"] = "";
+
+  auto NI = collectIncludes().IwyuNoIncludes;
+  ASSERT_TRUE(NI);
+  EXPECT_THAT(*NI,
+              UnorderedElementsAre(written("\"baz.h\""), written("<bar.h>"),
+                                   written("<valid>")));
+  IwyuNoInclude Inc;
+  Inc.Written = "\"baz.h\"";
+  EXPECT_THAT(calculate("\"baz.h\"", "", {}, {Inc}), "");
+  Inc.Written = "<bar.h>";
+  EXPECT_THAT(calculate("<bar.h>", "", {}, {Inc}), "");
+}
+
 TEST_F(HeadersTest, InsertInclude) {
   std::string Path = testPath("sub/bar.h");
   FS.Files[Path] = "";
   EXPECT_EQ(calculate(Path), "\"bar.h\"");
 }
 
 TEST_F(HeadersTest, DoNotInsertIfInSameFile) {
   MainFile = testPath("main.h");

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

 //===--- IncludeCleanerTests.cpp --------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 
 #include "Annotations.h"
 #include "Config.h"
 #include "IncludeCleaner.h"
+#include "Protocol.h"
 #include "SourceCode.h"
 #include "TestFS.h"
 #include "TestTU.h"
 #include "support/Context.h"
 #include "llvm/ADT/ScopeExit.h"
 #include "llvm/Testing/Support/SupportHelpers.h"
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
TEST(IncludeCleaner, IWYUPragmaExport) {
 
   EXPECT_THAT(AST.getDiagnostics(), llvm::ValueIs(IsEmpty()));
   // FIXME: This is not correct: foo.h is unused but is not diagnosed as such
   // because we ignore headers with IWYU export pragmas for now.
   EXPECT_THAT(computeUnusedIncludes(AST), IsEmpty());
   EXPECT_THAT(computeUnusedIncludesExperimental(AST), IsEmpty());
 }
 
+MATCHER_P(message, Message, "") { return arg.Message == Message; }
+MATCHER_P2(range, Start, End, "") {
+  return arg.start == Start && arg.end == End;
+}
+
+TEST(IncludeCleaner, IWYUPragmaNoInclude) {
+  TestTU TU;
+  TU.Code = R"cpp(
+#include "foo.h"
+#include "bar.h"
+// IWYU pragma: no_include "bar.h"
+  )cpp";
+  TU.AdditionalFiles["foo.h"] = guard("");
+  TU.AdditionalFiles["bar.h"] = guard("");
+  ParsedAST AST = TU.build();
+
+  auto Diags = issueNoIncludesDiagnostics(AST, TU.Code);
+  EXPECT_THAT(
+      Diags,
+      UnorderedElementsAre(message(
+          "included header 'bar.h' is marked as `no_include` at line 4")));
+  ASSERT_TRUE(Diags.size() == 1);
+  EXPECT_THAT(Diags.back().Fixes.size(), 1);
+  ASSERT_TRUE(Diags.back().Fixes.back().Edits.size() == 1);
+  EXPECT_THAT(Diags.back().Fixes.back().Edits.back().range,
+              range(Position{2, 0}, Position{3, 0}));
+}
+
 TEST(IncludeCleaner, NoDiagsForObjC) {
   TestTU TU;
   TU.Code = R"cpp(
     #include "foo.h"
 
     void bar() {}
     )cpp";
   TU.AdditionalFiles["foo.h"] = R"cpp(