clang-tools  14.0.0git
StringFindStartswithCheck.h
Go to the documentation of this file.
1 //===--- StringFindStartswithCheck.h - clang-tidy----------------*- C++ -*-===//
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 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "../utils/IncludeInserter.h"
14 #include "clang/ASTMatchers/ASTMatchFinder.h"
15 
16 #include <memory>
17 #include <string>
18 #include <vector>
19 
20 namespace clang {
21 namespace tidy {
22 namespace abseil {
23 
24 // Find string.find(...) == 0 comparisons and suggest replacing with StartsWith.
25 // FIXME(niko): Add similar check for EndsWith
26 // FIXME(niko): Add equivalent modernize checks for C++20's std::starts_With
28 public:
30  StringFindStartswithCheck(StringRef Name, ClangTidyContext *Context);
31  void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
32  Preprocessor *ModuleExpanderPP) override;
33  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
34  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
35  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
36 
37 private:
38  const std::vector<std::string> StringLikeClasses;
39  utils::IncludeInserter IncludeInserter;
40  const std::string AbseilStringsMatchHeader;
41 };
42 
43 } // namespace abseil
44 } // namespace tidy
45 } // namespace clang
46 
47 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
clang::tidy::abseil::StringFindStartswithCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: StringFindStartswithCheck.cpp:60
clang::tidy::ClangTidyOptions::OptionMap
llvm::StringMap< ClangTidyValue > OptionMap
Definition: ClangTidyOptions.h:115
clang::tidy::utils::IncludeInserter
Produces fixes to insert specified includes to source files, if not yet present.
Definition: IncludeInserter.h:55
clang::tidy::abseil::StringFindStartswithCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: StringFindStartswithCheck.cpp:34
clang::tidy::ClangTidyCheck::ClangTidyCheck
ClangTidyCheck(StringRef CheckName, ClangTidyContext *Context)
Initializes the check with CheckName and Context.
Definition: ClangTidyCheck.cpp:18
clang::tidy::abseil::StringFindStartswithCheck::StringFindStartswithCheck
StringFindStartswithCheck(StringRef Name, ClangTidyContext *Context)
Definition: StringFindStartswithCheck.cpp:24
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::abseil::StringFindStartswithCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
Definition: StringFindStartswithCheck.cpp:107
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:71
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
clang::tidy::abseil::StringFindStartswithCheck
Definition: StringFindStartswithCheck.h:27
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::abseil::StringFindStartswithCheck::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: StringFindStartswithCheck.cpp:112
SM
const SourceManager & SM
Definition: IncludeCleaner.cpp:140