c9aea86e6a
Summary: This patch introduces support for legacy C-style resource functions that must obey the 'owner<>' semantics. - added legacy creators like malloc,fopen,... - added legacy consumers like free,fclose,... This helps codes that mostly benefit from owner: Legacy, C-Style code that isn't feasable to port directly to RAII but needs a step in between to identify actual resource management and just using the resources. Reviewers: aaron.ballman, alexfh, hokein Reviewed By: aaron.ballman Subscribers: nemanjai, JDevlieghere, xazax.hun, kbarton Differential Revision: https://reviews.llvm.org/D38396 llvm-svn: 316092
64 lines
2.6 KiB
C++
64 lines
2.6 KiB
C++
//===--- OwningMemoryCheck.h - clang-tidy------------------------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H
|
|
|
|
#include "../ClangTidy.h"
|
|
|
|
namespace clang {
|
|
namespace tidy {
|
|
namespace cppcoreguidelines {
|
|
|
|
/// Checks for common use cases for gsl::owner and enforces the unique owner
|
|
/// nature of it whenever possible.
|
|
///
|
|
/// For the user-facing documentation see:
|
|
/// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-owning-memory.html
|
|
class OwningMemoryCheck : public ClangTidyCheck {
|
|
public:
|
|
OwningMemoryCheck(StringRef Name, ClangTidyContext *Context)
|
|
: ClangTidyCheck(Name, Context),
|
|
LegacyResourceProducers(Options.get(
|
|
"LegacyResourceProducers", "::malloc;::aligned_alloc;::realloc;"
|
|
"::calloc;::fopen;::freopen;::tmpfile")),
|
|
LegacyResourceConsumers(Options.get(
|
|
"LegacyResourceConsumers", "::free;::realloc;::freopen;::fclose")) {
|
|
}
|
|
|
|
/// Make configuration of checker discoverable.
|
|
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
|
|
|
|
void registerMatchers(ast_matchers::MatchFinder *Finder) override;
|
|
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
|
|
|
|
private:
|
|
bool handleDeletion(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleLegacyConsumers(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleExpectedOwner(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleAssignmentAndInit(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleAssignmentFromNewOwner(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleReturnValues(const ast_matchers::BoundNodes &Nodes);
|
|
bool handleOwnerMembers(const ast_matchers::BoundNodes &Nodes);
|
|
|
|
/// List of old C-style functions that create resources.
|
|
/// Defaults to
|
|
/// `::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile`.
|
|
const std::string LegacyResourceProducers;
|
|
/// List of old C-style functions that consume or release resources.
|
|
/// Defaults to `::free;::realloc;::freopen;::fclose`.
|
|
const std::string LegacyResourceConsumers;
|
|
};
|
|
|
|
} // namespace cppcoreguidelines
|
|
} // namespace tidy
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_OWNING_MEMORY_H
|