clang-tools 10.0.0

FasterStringFindCheck.cpp
Go to the documentation of this file.
1 //===--- FasterStringFindCheck.cpp - clang-tidy----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "FasterStringFindCheck.h"
10 #include "../utils/OptionsUtils.h"
11 #include "clang/AST/ASTContext.h"
12 #include "clang/ASTMatchers/ASTMatchFinder.h"
13 #include "llvm/ADT/Optional.h"
14 #include "llvm/Support/raw_ostream.h"
15
16 using namespace clang::ast_matchers;
17
18 namespace clang {
19 namespace tidy {
20 namespace performance {
21
22 namespace {
23
24 llvm::Optional<std::string> MakeCharacterLiteral(const StringLiteral *Literal) {
25 std::string Result;
26 {
27 llvm::raw_string_ostream OS(Result);
28 Literal->outputString(OS);
29 }
30 // Now replace the " with '.
31 auto pos = Result.find_first_of('"');
32 if (pos == Result.npos)
33 return llvm::None;
34 Result[pos] = '\'';
35 pos = Result.find_last_of('"');
36 if (pos == Result.npos)
37 return llvm::None;
38 Result[pos] = '\'';
39 return Result;
40 }
41
42 AST_MATCHER_FUNCTION(ast_matchers::internal::Matcher<Expr>,
43 hasSubstitutedType) {
44 return hasType(qualType(anyOf(substTemplateTypeParmType(),
45 hasDescendant(substTemplateTypeParmType()))));
46 }
47
48 } // namespace
49
50 FasterStringFindCheck::FasterStringFindCheck(StringRef Name,
51 ClangTidyContext *Context)
52 : ClangTidyCheck(Name, Context),
53 StringLikeClasses(utils::options::parseStringList(
54 Options.get("StringLikeClasses", "std::basic_string"))) {}
55
56 void FasterStringFindCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
57 Options.store(Opts, "StringLikeClasses",
58 utils::options::serializeStringList(StringLikeClasses));
59 }
60
61 void FasterStringFindCheck::registerMatchers(MatchFinder *Finder) {
62 if (!getLangOpts().CPlusPlus)
63 return;
64
65 const auto SingleChar =
66 expr(ignoringParenCasts(stringLiteral(hasSize(1)).bind("literal")));
67 const auto StringFindFunctions =
68 hasAnyName("find", "rfind", "find_first_of", "find_first_not_of",
69 "find_last_of", "find_last_not_of");
70
71 Finder->addMatcher(
72 cxxMemberCallExpr(
73 callee(functionDecl(StringFindFunctions).bind("func")),
74 anyOf(argumentCountIs(1), argumentCountIs(2)),
75 hasArgument(0, SingleChar),
76 on(expr(
77 hasType(hasUnqualifiedDesugaredType(recordType(hasDeclaration(
78 recordDecl(hasAnyName(SmallVector<StringRef, 4>(
79 StringLikeClasses.begin(), StringLikeClasses.end()))))))),
80 unless(hasSubstitutedType())))),
81 this);
82 }
83
84 void FasterStringFindCheck::check(const MatchFinder::MatchResult &Result) {
85 const auto *Literal = Result.Nodes.getNodeAs<StringLiteral>("literal");
86 const auto *FindFunc = Result.Nodes.getNodeAs<FunctionDecl>("func");
87
88 auto Replacement = MakeCharacterLiteral(Literal);
89 if (!Replacement)
90 return;
91
92 diag(Literal->getBeginLoc(), "%0 called with a string literal consisting of "
93 "a single character; consider using the more "
94 "effective overload accepting a character")
95 << FindFunc
96 << FixItHint::CreateReplacement(
97 CharSourceRange::getTokenRange(Literal->getBeginLoc(),
98 Literal->getEndLoc()),
99 *Replacement);
100 }
101
102 } // namespace performance
103 } // namespace tidy
104 } // namespace clang
clang::ast_matchers
Definition: AbseilMatcher.h:14
clang::tidy::performance::FasterStringFindCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition: FasterStringFindCheck.cpp:56
clang::tidy::utils::options::serializeStringList
std::string serializeStringList(ArrayRef< std::string > Strings)
Serialize a sequence of names that can be parsed by parseStringList.
Definition: OptionsUtils.cpp:30
clang::tidy::abseil::AST_MATCHER_FUNCTION
AST_MATCHER_FUNCTION(ast_matchers::internal::Matcher< FunctionDecl >, DurationConversionFunction)
Definition: DurationRewriter.h:99
clang::tidy::performance::FasterStringFindCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: FasterStringFindCheck.cpp:84
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::ClangTidyCheck::getLangOpts
const LangOptions & getLangOpts() const
Returns the language options from the context.
Definition: ClangTidyCheck.h:188
FasterStringFindCheck.h
clang::tidy::utils::options::parseStringList
std::vector< std::string > parseStringList(StringRef Option)
Parse a semicolon separated list of strings.
Definition: OptionsUtils.cpp:18
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:184
clang::tidy::ClangTidyCheck::OptionsView::store
void store(ClangTidyOptions::OptionMap &Options, StringRef LocalName, StringRef Value) const
Stores an option with the check-local name LocalName with string value Value to Options.
Definition: ClangTidyCheck.cpp:58
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition: ClangTidyOptions.h:97
clang::tidy::performance::FasterStringFindCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: FasterStringFindCheck.cpp:61
clang::clangd::getTokenRange
llvm::Optional< Range > getTokenRange(const SourceManager &SM, const LangOptions &LangOpts, SourceLocation TokLoc)
Returns the taken range at TokLoc.
Definition: SourceCode.cpp:227
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::ClangTidyCheck::diag
DiagnosticBuilder diag(SourceLocation Loc, StringRef Description, DiagnosticIDs::Level Level=DiagnosticIDs::Warning)
Add a diagnostic with the check&#39;s name.
Definition: ClangTidyCheck.cpp:21