clang-tools  8.0.0
StringFindStartswithCheck.h
Go to the documentation of this file.
1 //===--- StringFindStartswithCheck.h - clang-tidy----------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
11 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
12 
13 #include "../ClangTidy.h"
14 #include "../utils/IncludeInserter.h"
15 #include "clang/ASTMatchers/ASTMatchFinder.h"
16 
17 #include <memory>
18 #include <string>
19 #include <vector>
20 
21 namespace clang {
22 namespace tidy {
23 namespace abseil {
24 
25 // Find string.find(...) == 0 comparisons and suggest replacing with StartsWith.
26 // FIXME(niko): Add similar check for EndsWith
27 // FIXME(niko): Add equivalent modernize checks for C++20's std::starts_With
29 public:
31  StringFindStartswithCheck(StringRef Name, ClangTidyContext *Context);
32  void registerPPCallbacks(CompilerInstance &Compiler) 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  std::unique_ptr<clang::tidy::utils::IncludeInserter> IncludeInserter;
39  const std::vector<std::string> StringLikeClasses;
40  const utils::IncludeSorter::IncludeStyle IncludeStyle;
41  const std::string AbseilStringsMatchHeader;
42 };
43 
44 } // namespace abseil
45 } // namespace tidy
46 } // namespace clang
47 
48 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_ABSEIL_STRINGFINDSTARTSWITHCHECK_H
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
IncludeStyle
Supported include styles.
Definition: IncludeSorter.h:27
Base class for all clang-tidy checks.
Definition: ClangTidy.h:127
StringFindStartswithCheck(StringRef Name, ClangTidyContext *Context)
static constexpr llvm::StringLiteral Name
std::map< std::string, std::string > OptionMap
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
void registerPPCallbacks(CompilerInstance &Compiler) override
Override this to register PPCallbacks with Compiler.
ClangTidyCheck(StringRef CheckName, ClangTidyContext *Context)
Initializes the check with CheckName and Context.
Definition: ClangTidy.h:134
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.