clang-tools  14.0.0git
ShrinkToFitCheck.h
Go to the documentation of this file.
1 //===--- ShrinkToFitCheck.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_MODERNIZE_SHRINKTOFITCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_SHRINKTOFITCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang {
15 namespace tidy {
16 namespace modernize {
17 
18 /// Replace copy and swap tricks on shrinkable containers with the
19 /// `shrink_to_fit()` method call.
20 ///
21 /// The `shrink_to_fit()` method is more readable and more effective than
22 /// the copy and swap trick to reduce the capacity of a shrinkable container.
23 /// Note that, the `shrink_to_fit()` method is only available in C++11 and up.
25 public:
26  ShrinkToFitCheck(StringRef Name, ClangTidyContext *Context)
27  : ClangTidyCheck(Name, Context) {}
28  bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
29  return LangOpts.CPlusPlus11;
30  }
31  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
32  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
33  llvm::Optional<TraversalKind> getCheckTraversalKind() const override {
34  return TK_IgnoreUnlessSpelledInSource;
35  }
36 };
37 
38 } // namespace modernize
39 } // namespace tidy
40 } // namespace clang
41 
42 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_SHRINKTOFITCHECK_H
clang::tidy::modernize::ShrinkToFitCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: ShrinkToFitCheck.cpp:46
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:54
clang::tidy::modernize::ShrinkToFitCheck::isLanguageVersionSupported
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
Definition: ShrinkToFitCheck.h:28
clang::tidy::modernize::ShrinkToFitCheck::ShrinkToFitCheck
ShrinkToFitCheck(StringRef Name, ClangTidyContext *Context)
Definition: ShrinkToFitCheck.h:26
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:72
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:28
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::ShrinkToFitCheck
Replace copy and swap tricks on shrinkable containers with the shrink_to_fit() method call.
Definition: ShrinkToFitCheck.h:24
clang::tidy::modernize::ShrinkToFitCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: ShrinkToFitCheck.cpp:21
clang::tidy::modernize::ShrinkToFitCheck::getCheckTraversalKind
llvm::Optional< TraversalKind > getCheckTraversalKind() const override
Definition: ShrinkToFitCheck.h:33