clang-tools 10.0.0

ReplaceAutoPtrCheck.h
Go to the documentation of this file.
1 //===--- ReplaceAutoPtrCheck.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_REPLACE_AUTO_PTR_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_REPLACE_AUTO_PTR_H
11
12 #include "../ClangTidyCheck.h"
13 #include "../utils/IncludeInserter.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace modernize {
18
19 /// Transforms the deprecated `std::auto_ptr` into the C++11 `std::unique_ptr`.
20 ///
21 /// Note that both the `std::auto_ptr` type and the transfer of ownership are
22 /// transformed. `std::auto_ptr` provides two ways to transfer the ownership,
23 /// the copy-constructor and the assignment operator. Unlike most classes these
24 /// operations do not 'copy' the resource but they 'steal' it.
25 /// `std::unique_ptr` uses move semantics instead, which makes the intent of
26 /// transferring the resource explicit. This difference between the two smart
27 /// pointers requeres to wrap the copy-ctor and assign-operator with
28 /// `std::move()`.
29 ///
30 /// For example, given:
31 ///
32 /// \code
33 /// std::auto_ptr<int> i, j;
34 /// i = j;
35 /// \endcode
36 ///
37 /// This code is transformed to:
38 ///
39 /// \code
40 /// std::unique_ptr<in> i, j;
41 /// i = std::move(j);
42 /// \endcode
43 class ReplaceAutoPtrCheck : public ClangTidyCheck {
44 public:
45 ReplaceAutoPtrCheck(StringRef Name, ClangTidyContext *Context);
46 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
47 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
48 void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
49 Preprocessor *ModuleExpanderPP) override;
50 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
51
52 private:
53 std::unique_ptr<utils::IncludeInserter> Inserter;
54 const utils::IncludeSorter::IncludeStyle IncludeStyle;
55 };
56
57 } // namespace modernize
58 } // namespace tidy
59 } // namespace clang
60
61 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MODERNIZE_REPLACE_AUTO_PTR_H
clang::tidy::modernize::ReplaceAutoPtrCheck
Transforms the deprecated std::auto_ptr into the C++11 std::unique_ptr.
Definition: ReplaceAutoPtrCheck.h:43
clang::tidy::utils::IncludeSorter::IncludeStyle
IncludeStyle
Supported include styles.
Definition: IncludeSorter.h:26
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::modernize::ReplaceAutoPtrCheck::registerPPCallbacks
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP, Preprocessor *ModuleExpanderPP) override
Override this to register PPCallbacks in the preprocessor.
clang::tidy::modernize::ReplaceAutoPtrCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
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
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::tidy::modernize::ReplaceAutoPtrCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:28
clang::tidy::modernize::ReplaceAutoPtrCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition: ClangTidyDiagnosticConsumer.h:77
clang::tidy::modernize::ReplaceAutoPtrCheck::ReplaceAutoPtrCheck
ReplaceAutoPtrCheck(StringRef Name, ClangTidyContext *Context)