Skip to content

Commit

Permalink
[include-cleaner] Report all specializations if the primary template …
Browse files Browse the repository at this point in the history
…is introduced by a using-decl.

This will fix unused-include false positive.

```
// primary.h
namespace ns {
template<class T1, class T2> class Z {}; // primary template
}

// partial.h
namespace ns {
template<class T> class Z<T, T*> {};     // partial specialization
}

// main.cpp

using ns::Z; // refs to the primary
void k() {
  Z<int, int*> z; // use the partial specialization
}
```

Differential Revision: https://reviews.llvm.org/D152345
  • Loading branch information
hokein committed Jun 7, 2023
1 parent 1d153ea commit 100ffbf
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
28 changes: 28 additions & 0 deletions clang-tools-extra/include-cleaner/lib/WalkAST.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#include "clang/Basic/Specifiers.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/Support/Casting.h"

namespace clang::include_cleaner {
Expand Down Expand Up @@ -169,12 +170,39 @@ class ASTWalker : public RecursiveASTVisitor<ASTWalker> {
return true;
}

// Report all (partial) specializations of a class/var template decl.
template <typename TemplateDeclType, typename ParitialDeclType>
void reportSpecializations(SourceLocation Loc, NamedDecl *ND) {
const auto *TD = llvm::dyn_cast<TemplateDeclType>(ND);
if (!TD)
return;

for (auto *Spec : TD->specializations())
report(Loc, Spec, RefType::Ambiguous);
llvm::SmallVector<ParitialDeclType *> PartialSpecializations;
TD->getPartialSpecializations(PartialSpecializations);
for (auto *PartialSpec : PartialSpecializations)
report(Loc, PartialSpec, RefType::Ambiguous);
}
bool VisitUsingDecl(UsingDecl *UD) {
for (const auto *Shadow : UD->shadows()) {
auto *TD = Shadow->getTargetDecl();
auto IsUsed = TD->isUsed() || TD->isReferenced();
report(UD->getLocation(), TD,
IsUsed ? RefType::Explicit : RefType::Ambiguous);

// All (partial) template specializations are visible via a using-decl,
// However a using-decl only refers to the primary template (per C++ name
// lookup). Thus, we need to manually report all specializations.
reportSpecializations<ClassTemplateDecl,
ClassTemplatePartialSpecializationDecl>(
UD->getLocation(), TD);
reportSpecializations<VarTemplateDecl,
VarTemplatePartialSpecializationDecl>(
UD->getLocation(), TD);
if (const auto *FTD = llvm::dyn_cast<FunctionTemplateDecl>(TD))
for (auto *Spec : FTD->specializations())
report(UD->getLocation(), Spec, RefType::Ambiguous);
}
return true;
}
Expand Down
30 changes: 30 additions & 0 deletions clang-tools-extra/include-cleaner/unittests/WalkASTTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,36 @@ TEST(WalkAST, FunctionTemplates) {
"auto x = [] { ^foo<int>(); };"),
ElementsAre(Decl::FunctionTemplate));
}
TEST(WalkAST, TemplateSpecializationsFromUsingDecl) {
// Class templates
testWalk(R"cpp(
namespace ns {
template<class T> class $ambiguous^Z {}; // primary template
template<class T> class $ambiguous^Z<T*> {}; // partial specialization
template<> class $ambiguous^Z<int> {}; // full specialization
}
)cpp",
"using ns::^Z;");

// Var templates
testWalk(R"cpp(
namespace ns {
template<class T> T $ambiguous^foo; // primary template
template<class T> T $ambiguous^foo<T*>; // partial specialization
template<> int* $ambiguous^foo<int>; // full specialization
}
)cpp",
"using ns::^foo;");
// Function templates, no partial template specializations.
testWalk(R"cpp(
namespace ns {
template<class T> void $ambiguous^function(T); // primary template
template<> void $ambiguous^function(int); // full specialization
}
)cpp",
"using ns::^function;");
}


TEST(WalkAST, Alias) {
testWalk(R"cpp(
Expand Down

0 comments on commit 100ffbf

Please sign in to comment.