forked from OSchip/llvm-project
128 lines
4.6 KiB
C++
128 lines
4.6 KiB
C++
//===--- NamedParameterCheck.cpp - clang-tidy -------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "NamedParameterCheck.h"
|
|
#include "clang/AST/ASTContext.h"
|
|
#include "clang/ASTMatchers/ASTMatchFinder.h"
|
|
#include "clang/ASTMatchers/ASTMatchers.h"
|
|
|
|
using namespace clang::ast_matchers;
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace readability {
|
|
|
|
void NamedParameterCheck::registerMatchers(ast_matchers::MatchFinder *Finder) {
|
|
Finder->addMatcher(functionDecl(unless(isInstantiated())).bind("decl"), this);
|
|
}
|
|
|
|
void NamedParameterCheck::check(const MatchFinder::MatchResult &Result) {
|
|
const SourceManager &SM = *Result.SourceManager;
|
|
const auto *Function = Result.Nodes.getNodeAs<FunctionDecl>("decl");
|
|
SmallVector<std::pair<const FunctionDecl *, unsigned>, 4> UnnamedParams;
|
|
|
|
// Ignore implicitly generated members.
|
|
if (Function->isImplicit())
|
|
return;
|
|
|
|
// Ignore declarations without a definition if we're not dealing with an
|
|
// overriden method.
|
|
const FunctionDecl *Definition = nullptr;
|
|
if ((!Function->isDefined(Definition) || Function->isDefaulted() ||
|
|
Function->isDeleted()) &&
|
|
(!isa<CXXMethodDecl>(Function) ||
|
|
cast<CXXMethodDecl>(Function)->size_overridden_methods() == 0))
|
|
return;
|
|
|
|
// TODO: Handle overloads.
|
|
// TODO: We could check that all redeclarations use the same name for
|
|
// arguments in the same position.
|
|
for (unsigned I = 0, E = Function->getNumParams(); I != E; ++I) {
|
|
const ParmVarDecl *Parm = Function->getParamDecl(I);
|
|
if (Parm->isImplicit())
|
|
continue;
|
|
// Look for unnamed parameters.
|
|
if (!Parm->getName().empty())
|
|
continue;
|
|
|
|
// Don't warn on the dummy argument on post-inc and post-dec operators.
|
|
if ((Function->getOverloadedOperator() == OO_PlusPlus ||
|
|
Function->getOverloadedOperator() == OO_MinusMinus) &&
|
|
Parm->getType()->isSpecificBuiltinType(BuiltinType::Int))
|
|
continue;
|
|
|
|
// Sanity check the source locations.
|
|
if (!Parm->getLocation().isValid() || Parm->getLocation().isMacroID() ||
|
|
!SM.isWrittenInSameFile(Parm->getLocStart(), Parm->getLocation()))
|
|
continue;
|
|
|
|
// Skip gmock testing::Unused parameters.
|
|
if (auto Typedef = Parm->getType()->getAs<clang::TypedefType>())
|
|
if (Typedef->getDecl()->getQualifiedNameAsString() == "testing::Unused")
|
|
continue;
|
|
|
|
// Skip std::nullptr_t.
|
|
if (Parm->getType().getCanonicalType()->isNullPtrType())
|
|
continue;
|
|
|
|
// Look for comments. We explicitly want to allow idioms like
|
|
// void foo(int /*unused*/)
|
|
const char *Begin = SM.getCharacterData(Parm->getLocStart());
|
|
const char *End = SM.getCharacterData(Parm->getLocation());
|
|
StringRef Data(Begin, End - Begin);
|
|
if (Data.find("/*") != StringRef::npos)
|
|
continue;
|
|
|
|
UnnamedParams.push_back(std::make_pair(Function, I));
|
|
}
|
|
|
|
// Emit only one warning per function but fixits for all unnamed parameters.
|
|
if (!UnnamedParams.empty()) {
|
|
const ParmVarDecl *FirstParm =
|
|
UnnamedParams.front().first->getParamDecl(UnnamedParams.front().second);
|
|
auto D = diag(FirstParm->getLocation(),
|
|
"all parameters should be named in a function");
|
|
|
|
for (auto P : UnnamedParams) {
|
|
// Fallback to an unused marker.
|
|
StringRef NewName = "unused";
|
|
|
|
// If the method is overridden, try to copy the name from the base method
|
|
// into the overrider.
|
|
const auto *M = dyn_cast<CXXMethodDecl>(P.first);
|
|
if (M && M->size_overridden_methods() > 0) {
|
|
const ParmVarDecl *OtherParm =
|
|
(*M->begin_overridden_methods())->getParamDecl(P.second);
|
|
StringRef Name = OtherParm->getName();
|
|
if (!Name.empty())
|
|
NewName = Name;
|
|
}
|
|
|
|
// If the definition has a named parameter use that name.
|
|
if (Definition) {
|
|
const ParmVarDecl *DefParm = Definition->getParamDecl(P.second);
|
|
StringRef Name = DefParm->getName();
|
|
if (!Name.empty())
|
|
NewName = Name;
|
|
}
|
|
|
|
// Now insert the comment. Note that getLocation() points to the place
|
|
// where the name would be, this allows us to also get complex cases like
|
|
// function pointers right.
|
|
const ParmVarDecl *Parm = P.first->getParamDecl(P.second);
|
|
D << FixItHint::CreateInsertion(Parm->getLocation(),
|
|
" /*" + NewName.str() + "*/");
|
|
}
|
|
}
|
|
}
|
|
|
|
} // namespace readability
|
|
} // namespace tidy
|
|
} // namespace clang
|