35 const MatchFinder::MatchResult &Result) {
40 assert((Qual == Qualifier::Const || Qual == Qualifier::Volatile ||
41 Qual == Qualifier::Restrict) &&
44 SourceLocation BeginLoc = Decl->getQualifierLoc().getBeginLoc();
45 if (BeginLoc.isInvalid())
46 BeginLoc = Decl->getBeginLoc();
47 SourceLocation EndLoc = Decl->getLocation();
49 CharSourceRange FileRange = Lexer::makeFileCharRange(
50 CharSourceRange::getCharRange(BeginLoc, EndLoc), *Result.SourceManager,
51 Result.Context->getLangOpts());
53 if (FileRange.isInvalid())
56 tok::TokenKind Tok = Qual == Qualifier::Const ? tok::kw_const
57 : Qual == Qualifier::Volatile ? tok::kw_volatile
61 *Result.SourceManager);
121 auto ExplicitSingleVarDecl =
122 [](
const ast_matchers::internal::Matcher<VarDecl> &InnerMatcher,
123 llvm::StringRef ID) {
125 unless(isInTemplateInstantiation()),
127 varDecl(unless(isImplicit()), InnerMatcher).bind(ID)));
129 auto ExplicitSingleVarDeclInTemplate =
130 [](
const ast_matchers::internal::Matcher<VarDecl> &InnerMatcher,
131 llvm::StringRef ID) {
133 isInTemplateInstantiation(),
135 varDecl(unless(isImplicit()), InnerMatcher).bind(ID)));
138 auto IsBoundToType = refersToType(equalsBoundNode(
"type"));
139 auto UnlessFunctionType = unless(hasUnqualifiedDesugaredType(functionType()));
141 auto IsPointerType = [
this](
const auto &...InnerMatchers) {
142 if (this->IgnoreAliasing) {
144 hasUnqualifiedDesugaredType(pointerType(pointee(InnerMatchers...))));
146 return qualType(anyOf(qualType(pointerType(pointee(InnerMatchers...))),
147 qualType(substTemplateTypeParmType(hasReplacementType(
148 pointerType(pointee(InnerMatchers...)))))));
152 auto IsAutoDeducedToPointer =
153 [IsPointerType](
const std::vector<StringRef> &AllowedTypes,
154 const auto &...InnerMatchers) {
155 return autoType(hasDeducedType(
156 IsPointerType(InnerMatchers...),
157 unless(hasUnqualifiedType(
159 unless(pointerType(pointee(hasUnqualifiedType(
164 ExplicitSingleVarDecl(
165 hasType(IsAutoDeducedToPointer(AllowedTypes, UnlessFunctionType)),
170 ExplicitSingleVarDeclInTemplate(
171 allOf(hasType(IsAutoDeducedToPointer(
172 AllowedTypes, hasUnqualifiedType(qualType().bind(
"type")),
173 UnlessFunctionType)),
175 functionDecl(hasAnyTemplateArgument(IsBoundToType))),
176 hasAncestor(classTemplateSpecializationDecl(
177 hasAnyTemplateArgument(IsBoundToType))))),
180 if (!AddConstToQualified)
182 Finder->addMatcher(ExplicitSingleVarDecl(
183 hasType(pointerType(pointee(autoType()))),
"auto_ptr"),
186 ExplicitSingleVarDecl(hasType(lValueReferenceType(pointee(autoType()))),
192 if (
const auto *Var = Result.Nodes.getNodeAs<VarDecl>(
"auto")) {
193 SourceRange TypeSpecifier;
194 if (std::optional<SourceRange> TypeSpec =
196 TypeSpecifier = *TypeSpec;
200 llvm::SmallVector<SourceRange, 4> RemoveQualifiersRange;
201 auto CheckQualifier = [&](
bool IsPresent, Qualifier Qual) {
203 std::optional<Token> Token =
findQualToken(Var, Qual, Result);
204 if (!Token || Token->getLocation().isMacroID())
206 if (std::optional<SourceRange> Result =
208 RemoveQualifiersRange.push_back(*Result);
213 bool IsLocalConst = Var->getType().isLocalConstQualified();
214 bool IsLocalVolatile = Var->getType().isLocalVolatileQualified();
215 bool IsLocalRestrict = Var->getType().isLocalRestrictQualified();
217 if (CheckQualifier(IsLocalConst, Qualifier::Const) ||
218 CheckQualifier(IsLocalVolatile, Qualifier::Volatile) ||
219 CheckQualifier(IsLocalRestrict, Qualifier::Restrict))
223 if (Var->getLocation() == TypeSpecifier.getEnd().getLocWithOffset(1))
224 TypeSpecifier.setEnd(TypeSpecifier.getEnd().getLocWithOffset(1));
226 CharSourceRange FixItRange = CharSourceRange::getCharRange(TypeSpecifier);
227 if (FixItRange.isInvalid())
230 SourceLocation FixitLoc = FixItRange.getBegin();
231 for (SourceRange &Range : RemoveQualifiersRange) {
232 if (Range.getBegin() < FixitLoc)
233 FixitLoc = Range.getBegin();
236 std::string ReplStr = [&] {
237 llvm::StringRef PtrConst =
isPointerConst(Var->getType()) ?
"const " :
"";
238 llvm::StringRef LocalConst = IsLocalConst ?
"const " :
"";
239 llvm::StringRef LocalVol = IsLocalVolatile ?
"volatile " :
"";
240 llvm::StringRef LocalRestrict = IsLocalRestrict ?
"__restrict " :
"";
241 return (PtrConst +
"auto *" + LocalConst + LocalVol + LocalRestrict)
245 DiagnosticBuilder Diag =
247 "'%select{|const }0%select{|volatile }1%select{|__restrict }2auto "
248 "%3' can be declared as '%4%3'")
249 << IsLocalConst << IsLocalVolatile << IsLocalRestrict << Var->getName()
252 for (SourceRange &Range : RemoveQualifiersRange) {
253 Diag << FixItHint::CreateRemoval(CharSourceRange::getCharRange(Range));
256 Diag << FixItHint::CreateReplacement(FixItRange, ReplStr);
259 if (
const auto *Var = Result.Nodes.getNodeAs<VarDecl>(
"auto_ptr")) {
266 if (Var->getType().isLocalConstQualified()) {
267 std::optional<Token> Token =
findQualToken(Var, Qualifier::Const, Result);
268 if (!Token || Token->getLocation().isMacroID())
271 if (Var->getType().isLocalVolatileQualified()) {
272 std::optional<Token> Token =
274 if (!Token || Token->getLocation().isMacroID())
277 if (Var->getType().isLocalRestrictQualified()) {
278 std::optional<Token> Token =
280 if (!Token || Token->getLocation().isMacroID())
284 if (std::optional<SourceRange> TypeSpec =
286 if (TypeSpec->isInvalid() || TypeSpec->getBegin().isMacroID() ||
287 TypeSpec->getEnd().isMacroID())
289 SourceLocation InsertPos = TypeSpec->getBegin();
291 "'auto *%select{|const }0%select{|volatile }1%2' can be declared as "
292 "'const auto *%select{|const }0%select{|volatile }1%2'")
293 << Var->getType().isLocalConstQualified()
294 << Var->getType().isLocalVolatileQualified() << Var->getName()
295 << FixItHint::CreateInsertion(InsertPos,
"const ");
299 if (
const auto *Var = Result.Nodes.getNodeAs<VarDecl>(
"auto_ref")) {
306 if (std::optional<SourceRange> TypeSpec =
308 if (TypeSpec->isInvalid() || TypeSpec->getBegin().isMacroID() ||
309 TypeSpec->getEnd().isMacroID())
311 SourceLocation InsertPos = TypeSpec->getBegin();
312 diag(InsertPos,
"'auto &%0' can be declared as 'const auto &%0'")
313 << Var->getName() << FixItHint::CreateInsertion(InsertPos,
"const ");
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.