annotate clang-tools-extra/clang-tidy/cppcoreguidelines/OwningMemoryCheck.h @ 173:0572611fdcc8 llvm10 llvm12

reorgnization done
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 11:55:54 +0900
parents 1d019706d866
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- OwningMemoryCheck.h - clang-tidy------------------------*- C++ -*-===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H
anatofuz
parents:
diff changeset
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H
anatofuz
parents:
diff changeset
11
anatofuz
parents:
diff changeset
12 #include "../ClangTidy.h"
anatofuz
parents:
diff changeset
13
anatofuz
parents:
diff changeset
14 namespace clang {
anatofuz
parents:
diff changeset
15 namespace tidy {
anatofuz
parents:
diff changeset
16 namespace cppcoreguidelines {
anatofuz
parents:
diff changeset
17
anatofuz
parents:
diff changeset
18 /// Checks for common use cases for gsl::owner and enforces the unique owner
anatofuz
parents:
diff changeset
19 /// nature of it whenever possible.
anatofuz
parents:
diff changeset
20 ///
anatofuz
parents:
diff changeset
21 /// For the user-facing documentation see:
anatofuz
parents:
diff changeset
22 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-owning-memory.html
anatofuz
parents:
diff changeset
23 class OwningMemoryCheck : public ClangTidyCheck {
anatofuz
parents:
diff changeset
24 public:
anatofuz
parents:
diff changeset
25 OwningMemoryCheck(StringRef Name, ClangTidyContext *Context)
anatofuz
parents:
diff changeset
26 : ClangTidyCheck(Name, Context),
anatofuz
parents:
diff changeset
27 LegacyResourceProducers(Options.get(
anatofuz
parents:
diff changeset
28 "LegacyResourceProducers", "::malloc;::aligned_alloc;::realloc;"
anatofuz
parents:
diff changeset
29 "::calloc;::fopen;::freopen;::tmpfile")),
anatofuz
parents:
diff changeset
30 LegacyResourceConsumers(Options.get(
anatofuz
parents:
diff changeset
31 "LegacyResourceConsumers", "::free;::realloc;::freopen;::fclose")) {
anatofuz
parents:
diff changeset
32 }
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
33 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
34 return LangOpts.CPlusPlus11;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
35 }
150
anatofuz
parents:
diff changeset
36
anatofuz
parents:
diff changeset
37 /// Make configuration of checker discoverable.
anatofuz
parents:
diff changeset
38 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
anatofuz
parents:
diff changeset
39
anatofuz
parents:
diff changeset
40 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
anatofuz
parents:
diff changeset
41 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
anatofuz
parents:
diff changeset
42
anatofuz
parents:
diff changeset
43 private:
anatofuz
parents:
diff changeset
44 bool handleDeletion(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
45 bool handleLegacyConsumers(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
46 bool handleExpectedOwner(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
47 bool handleAssignmentAndInit(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
48 bool handleAssignmentFromNewOwner(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
49 bool handleReturnValues(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
50 bool handleOwnerMembers(const ast_matchers::BoundNodes &Nodes);
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 /// List of old C-style functions that create resources.
anatofuz
parents:
diff changeset
53 /// Defaults to
anatofuz
parents:
diff changeset
54 /// `::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile`.
anatofuz
parents:
diff changeset
55 const std::string LegacyResourceProducers;
anatofuz
parents:
diff changeset
56 /// List of old C-style functions that consume or release resources.
anatofuz
parents:
diff changeset
57 /// Defaults to `::free;::realloc;::freopen;::fclose`.
anatofuz
parents:
diff changeset
58 const std::string LegacyResourceConsumers;
anatofuz
parents:
diff changeset
59 };
anatofuz
parents:
diff changeset
60
anatofuz
parents:
diff changeset
61 } // namespace cppcoreguidelines
anatofuz
parents:
diff changeset
62 } // namespace tidy
anatofuz
parents:
diff changeset
63 } // namespace clang
anatofuz
parents:
diff changeset
64
anatofuz
parents:
diff changeset
65 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H