hokein created this revision.
hokein added a reviewer: VitaNuo.
Herald added subscribers: PiotrZSL, kadircet, carlosgalvezp, arphaman,
xazax.hun.
Herald added a reviewer: njames93.
Herald added a project: All.
hokein requested review of this revision.
Herald added a project: clang-tools-extra.
We should print the symbol name rather than the header name in the
message.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D153013
Files:
clang-tools-extra/clang-tidy/misc/IncludeCleanerCheck.cpp
clang-tools-extra/clangd/IncludeCleaner.cpp
clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
clang-tools-extra/include-cleaner/lib/Types.cpp
clang-tools-extra/test/clang-tidy/checkers/misc/include-cleaner.cpp
Index: clang-tools-extra/test/clang-tidy/checkers/misc/include-cleaner.cpp
===================================================================
--- clang-tools-extra/test/clang-tidy/checkers/misc/include-cleaner.cpp
+++ clang-tools-extra/test/clang-tidy/checkers/misc/include-cleaner.cpp
@@ -10,8 +10,8 @@
// CHECK-FIXES: {{^}}
int BarResult = bar();
int BazResult = baz();
-// CHECK-MESSAGES: :[[@LINE-1]]:17: warning: no header providing "baz.h" is directly included [misc-include-cleaner]
+// CHECK-MESSAGES: :[[@LINE-1]]:17: warning: no header providing "baz" is directly included [misc-include-cleaner]
std::string HelloString;
-// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: no header providing <string> is directly included [misc-include-cleaner]
+// CHECK-MESSAGES: :[[@LINE-1]]:6: warning: no header providing "std::string" is directly included [misc-include-cleaner]
int FooBarResult = foobar();
-// CHECK-MESSAGES: :[[@LINE-1]]:20: warning: no header providing "public.h" is directly included [misc-include-cleaner]
+// CHECK-MESSAGES: :[[@LINE-1]]:20: warning: no header providing "foobar" is directly included [misc-include-cleaner]
Index: clang-tools-extra/include-cleaner/lib/Types.cpp
===================================================================
--- clang-tools-extra/include-cleaner/lib/Types.cpp
+++ clang-tools-extra/include-cleaner/lib/Types.cpp
@@ -15,6 +15,17 @@
namespace clang::include_cleaner {
+std::string Symbol::name() const {
+ switch (kind()) {
+ case include_cleaner::Symbol::Macro:
+ return macro().Name->getName().str();
+ case include_cleaner::Symbol::Declaration:
+ return llvm::dyn_cast<NamedDecl>(&declaration())
+ ->getQualifiedNameAsString();
+ }
+ llvm_unreachable("Unknown symbol kind");
+}
+
llvm::raw_ostream &operator<<(llvm::raw_ostream &OS, const Symbol &S) {
switch (S.kind()) {
case Symbol::Declaration:
Index: clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
===================================================================
--- clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
+++ clang-tools-extra/include-cleaner/include/clang-include-cleaner/Types.h
@@ -67,6 +67,7 @@
const Decl &declaration() const { return *std::get<Declaration>(Storage); }
struct Macro macro() const { return std::get<Macro>(Storage); }
+ std::string name() const;
private:
// Order must match Kind enum!
Index: clang-tools-extra/clangd/IncludeCleaner.cpp
===================================================================
--- clang-tools-extra/clangd/IncludeCleaner.cpp
+++ clang-tools-extra/clangd/IncludeCleaner.cpp
@@ -144,17 +144,6 @@
llvm_unreachable("Unknown header kind");
}
-std::string getSymbolName(const include_cleaner::Symbol &Sym) {
- switch (Sym.kind()) {
- case include_cleaner::Symbol::Macro:
- return Sym.macro().Name->getName().str();
- case include_cleaner::Symbol::Declaration:
- return llvm::dyn_cast<NamedDecl>(&Sym.declaration())
- ->getQualifiedNameAsString();
- }
- llvm_unreachable("Unknown symbol kind");
-}
-
std::vector<Diag> generateMissingIncludeDiagnostics(
ParsedAST &AST, llvm::ArrayRef<MissingIncludeDiagInfo> MissingIncludes,
llvm::StringRef Code, HeaderFilter IgnoreHeaders) {
@@ -199,7 +188,7 @@
Diag &D = Result.emplace_back();
D.Message =
llvm::formatv("No header providing \"{0}\" is directly included",
- getSymbolName(SymbolWithMissingInclude.Symbol));
+ SymbolWithMissingInclude.Symbol.name());
D.Name = "missing-includes";
D.Source = Diag::DiagSource::Clangd;
D.File = AST.tuPath();
Index: clang-tools-extra/clang-tidy/misc/IncludeCleanerCheck.cpp
===================================================================
--- clang-tools-extra/clang-tidy/misc/IncludeCleanerCheck.cpp
+++ clang-tools-extra/clang-tidy/misc/IncludeCleanerCheck.cpp
@@ -46,6 +46,7 @@
namespace {
struct MissingIncludeInfo {
SourceLocation SymRefLocation;
+ include_cleaner::Symbol Sym;
include_cleaner::Header Missing;
};
} // namespace
@@ -115,27 +116,27 @@
}
// FIXME: Find a way to have less code duplication between include-cleaner
// analysis implementation and the below code.
- walkUsed(MainFileDecls, RecordedPreprocessor.MacroReferences, &RecordedPI,
- *SM,
- [&](const include_cleaner::SymbolReference &Ref,
- llvm::ArrayRef<include_cleaner::Header> Providers) {
- bool Satisfied = false;
- for (const include_cleaner::Header &H : Providers) {
- if (H.kind() == include_cleaner::Header::Physical &&
- H.physical() == MainFile)
- Satisfied = true;
-
- for (const include_cleaner::Include *I :
- RecordedPreprocessor.Includes.match(H)) {
- Used.insert(I);
- Satisfied = true;
- }
- }
- if (!Satisfied && !Providers.empty() &&
- Ref.RT == include_cleaner::RefType::Explicit &&
- !shouldIgnore(Providers.front()))
- Missing.push_back({Ref.RefLocation, Providers.front()});
- });
+ walkUsed(
+ MainFileDecls, RecordedPreprocessor.MacroReferences, &RecordedPI, *SM,
+ [&](const include_cleaner::SymbolReference &Ref,
+ llvm::ArrayRef<include_cleaner::Header> Providers) {
+ bool Satisfied = false;
+ for (const include_cleaner::Header &H : Providers) {
+ if (H.kind() == include_cleaner::Header::Physical &&
+ H.physical() == MainFile)
+ Satisfied = true;
+
+ for (const include_cleaner::Include *I :
+ RecordedPreprocessor.Includes.match(H)) {
+ Used.insert(I);
+ Satisfied = true;
+ }
+ }
+ if (!Satisfied && !Providers.empty() &&
+ Ref.RT == include_cleaner::RefType::Explicit &&
+ !shouldIgnore(Providers.front()))
+ Missing.push_back({Ref.RefLocation, Ref.Target, Providers.front()});
+ });
std::vector<const include_cleaner::Include *> Unused;
for (const include_cleaner::Include &I :
@@ -191,8 +192,8 @@
HeaderIncludes.insert(llvm::StringRef{Spelling}.trim("\"<>"),
Angled, tooling::IncludeDirective::Include))
diag(SM->getSpellingLoc(Inc.SymRefLocation),
- "no header providing %0 is directly included")
- << Spelling
+ "no header providing \"%0\" is directly included")
+ << Inc.Sym.name()
<< FixItHint::CreateInsertion(
SM->getComposedLoc(SM->getMainFileID(),
Replacement->getOffset()),
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
