10#include "clang/AST/ASTContext.h"
11#include "clang/ASTMatchers/ASTMatchFinder.h"
12#include "clang/ASTMatchers/ASTMatchers.h"
13#include "clang/Lex/Lexer.h"
21 cxxConstructorDecl(unless(anyOf(isImplicit(),
22 isDeleted(), isInstantiated())))
26 cxxConversionDecl(unless(anyOf(isExplicit(),
28 isDeleted(), isInstantiated())))
36static SourceRange
findToken(
const SourceManager &Sources,
37 const LangOptions &LangOpts,
38 SourceLocation StartLoc, SourceLocation EndLoc,
39 bool (*Pred)(
const Token &)) {
40 if (StartLoc.isMacroID() || EndLoc.isMacroID())
42 FileID File = Sources.getFileID(Sources.getSpellingLoc(StartLoc));
43 StringRef Buf = Sources.getBufferData(File);
44 const char *StartChar = Sources.getCharacterData(StartLoc);
45 Lexer Lex(StartLoc, LangOpts, StartChar, StartChar, Buf.end());
46 Lex.SetCommentRetentionState(
true);
49 Lex.LexFromRawLexer(Tok);
52 Lex.LexFromRawLexer(NextTok);
53 return {Tok.getLocation(), NextTok.getLocation()};
55 }
while (Tok.isNot(tok::eof) && Tok.getLocation() < EndLoc);
63 return D->getName() ==
"initializer_list" &&
64 D->getQualifiedNameAsString() ==
"std::initializer_list";
69 if (
const auto *TS =
Type->getAs<TemplateSpecializationType>()) {
70 if (
const TemplateDecl *TD = TS->getTemplateName().getAsTemplateDecl())
73 if (
const auto *RT =
Type->getAs<RecordType>()) {
74 if (
const auto *Specialization =
75 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl()))
82 constexpr char NoExpressionWarningMessage[] =
83 "%0 must be marked explicit to avoid unintentional implicit conversions";
84 constexpr char WithExpressionWarningMessage[] =
85 "%0 explicit expression evaluates to 'false'";
87 if (
const auto *Conversion =
88 Result.Nodes.getNodeAs<CXXConversionDecl>(
"conversion")) {
89 if (Conversion->isOutOfLine())
91 SourceLocation
Loc = Conversion->getLocation();
96 diag(
Loc, NoExpressionWarningMessage)
97 << Conversion << FixItHint::CreateInsertion(
Loc,
"explicit ");
101 const auto *Ctor = Result.Nodes.getNodeAs<CXXConstructorDecl>(
"ctor");
102 if (Ctor->isOutOfLine() || Ctor->getNumParams() == 0 ||
103 Ctor->getMinRequiredArguments() > 1)
106 const ExplicitSpecifier ExplicitSpec = Ctor->getExplicitSpecifier();
109 Ctor->getParamDecl(0)->getType().getNonReferenceType());
110 if (ExplicitSpec.isExplicit() &&
111 (Ctor->isCopyOrMoveConstructor() || TakesInitializerList)) {
112 auto IsKwExplicit = [](
const Token &Tok) {
113 return Tok.is(tok::raw_identifier) &&
114 Tok.getRawIdentifier() ==
"explicit";
116 SourceRange ExplicitTokenRange =
118 Ctor->getOuterLocStart(), Ctor->getEndLoc(), IsKwExplicit);
119 StringRef ConstructorDescription;
120 if (Ctor->isMoveConstructor())
121 ConstructorDescription =
"move";
122 else if (Ctor->isCopyConstructor())
123 ConstructorDescription =
"copy";
125 ConstructorDescription =
"initializer-list";
127 auto Diag =
diag(Ctor->getLocation(),
128 "%0 constructor should not be declared explicit")
129 << ConstructorDescription;
130 if (ExplicitTokenRange.isValid()) {
131 Diag << FixItHint::CreateRemoval(
132 CharSourceRange::getCharRange(ExplicitTokenRange));
137 if (ExplicitSpec.isExplicit() || Ctor->isCopyOrMoveConstructor() ||
138 TakesInitializerList)
142 const Expr *ExplicitExpr = ExplicitSpec.getExpr();
144 ExplicitExpr = ExplicitExpr->IgnoreImplicit();
145 if (isa<CXXBoolLiteralExpr>(ExplicitExpr) ||
146 ExplicitExpr->isInstantiationDependent())
150 const bool SingleArgument =
151 Ctor->getNumParams() == 1 && !Ctor->getParamDecl(0)->isParameterPack();
152 SourceLocation
Loc = Ctor->getLocation();
154 diag(
Loc, ExplicitExpr ? WithExpressionWarningMessage
155 : NoExpressionWarningMessage)
157 ?
"single-argument constructors"
158 :
"constructors that are callable with a single argument");
161 Diag << FixItHint::CreateInsertion(
Loc,
"explicit ");
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check's name.
const LangOptions & getLangOpts() const
Returns the language options from the context.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
static bool isStdInitializerList(QualType Type)
static SourceRange findToken(const SourceManager &Sources, const LangOptions &LangOpts, SourceLocation StartLoc, SourceLocation EndLoc, bool(*Pred)(const Token &))
static bool declIsStdInitializerList(const NamedDecl *D)