11 #include "clang/ASTMatchers/ASTMatchFinder.h"
12 #include "clang/ASTMatchers/ASTMatchers.h"
13 #include "clang/Lex/Lexer.h"
14 #include "llvm/ADT/Optional.h"
16 using namespace clang::ast_matchers;
20 namespace readability {
23 SourceRange getTypeRange(
const ParmVarDecl &Param) {
24 if (Param.getIdentifier() !=
nullptr)
25 return SourceRange(Param.getLocStart(),
26 Param.getLocEnd().getLocWithOffset(-1));
27 return Param.getSourceRange();
32 void AvoidConstParamsInDecls::registerMatchers(MatchFinder *
Finder) {
33 const auto ConstParamDecl =
34 parmVarDecl(hasType(qualType(isConstQualified()))).bind(
"param");
36 functionDecl(unless(isDefinition()),
43 unless(cxxMethodDecl(ofClass(cxxRecordDecl(anyOf(
44 isLambda(), ast_matchers::isTemplateInstantiation()))))),
45 has(typeLoc(forEach(ConstParamDecl))))
52 const MatchFinder::MatchResult &
Result) {
53 const SourceManager &Sources = *Result.SourceManager;
54 std::pair<FileID, unsigned> LocInfo =
55 Sources.getDecomposedLoc(Range.getBegin());
56 StringRef
File = Sources.getBufferData(LocInfo.first);
57 const char *TokenBegin = File.data() + LocInfo.second;
58 Lexer RawLexer(Sources.getLocForStartOfFile(LocInfo.first),
59 Result.Context->getLangOpts(), File.begin(), TokenBegin,
63 while (!RawLexer.LexFromRawLexer(Tok)) {
64 if (Sources.isBeforeInTranslationUnit(Range.getEnd(), Tok.getLocation()))
66 if (Tok.is(tok::raw_identifier)) {
67 IdentifierInfo &Info = Result.Context->Idents.get(StringRef(
68 Sources.getCharacterData(Tok.getLocation()), Tok.getLength()));
69 Tok.setIdentifierInfo(&Info);
70 Tok.setKind(Info.getTokenID());
72 if (Tok.is(tok::kw_const))
78 void AvoidConstParamsInDecls::check(
const MatchFinder::MatchResult &
Result) {
79 const auto *Func = Result.Nodes.getNodeAs<FunctionDecl>(
"func");
80 const auto *Param = Result.Nodes.getNodeAs<ParmVarDecl>(
"param");
82 if (!Param->getType().isLocalConstQualified())
85 auto Diag = diag(Param->getLocStart(),
86 "parameter %0 is const-qualified in the function "
87 "declaration; const-qualification of parameters only has an "
88 "effect in function definitions");
89 if (Param->getName().empty()) {
90 for (
unsigned int i = 0; i < Func->getNumParams(); ++i) {
91 if (Param == Func->getParamDecl(i)) {
100 if (Param->getLocStart().isMacroID() != Param->getLocEnd().isMacroID()) {
106 CharSourceRange FileRange = Lexer::makeFileCharRange(
107 CharSourceRange::getTokenRange(getTypeRange(*Param)),
108 *Result.SourceManager, getLangOpts());
110 if (!FileRange.isValid())
113 auto Tok =
ConstTok(FileRange, Result);
116 Diag << FixItHint::CreateRemoval(
117 CharSourceRange::getTokenRange(Tok->getLocation(), Tok->getLocation()));
std::unique_ptr< ast_matchers::MatchFinder > Finder
static llvm::Optional< Token > ConstTok(CharSourceRange Range, const MatchFinder::MatchResult &Result)
CharSourceRange Range
SourceRange for the file name.