1 //===--- NoMallocCheck.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_CPPCOREGUIDELINES_NO_MALLOC_H 10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NO_MALLOC_H 11 12 #include "../ClangTidyCheck.h" 13 14 namespace clang::tidy::cppcoreguidelines { 15 16 /// This checker is concerned with C-style memory management and suggest modern 17 /// alternatives to it. 18 /// The check is only enabled in C++. For analyzing malloc calls see Clang 19 /// Static Analyzer - unix.Malloc. 20 /// 21 /// For the user-facing documentation see: 22 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/no-malloc.html 23 class NoMallocCheck : public ClangTidyCheck { 24 public: 25 /// Construct Checker and read in configuration for function names. NoMallocCheck(StringRef Name,ClangTidyContext * Context)26 NoMallocCheck(StringRef Name, ClangTidyContext *Context) 27 : ClangTidyCheck(Name, Context), 28 AllocList(Options.get("Allocations", "::malloc;::calloc")), 29 ReallocList(Options.get("Reallocations", "::realloc")), 30 DeallocList(Options.get("Deallocations", "::free")) {} 31 isLanguageVersionSupported(const LangOptions & LangOpts)32 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override { 33 return LangOpts.CPlusPlus; 34 } 35 36 /// Make configuration of checker discoverable. 37 void storeOptions(ClangTidyOptions::OptionMap &Opts) override; 38 39 /// Registering for malloc, calloc, realloc and free calls. 40 void registerMatchers(ast_matchers::MatchFinder *Finder) override; 41 42 /// Checks matched function calls and gives suggestion to modernize the code. 43 void check(const ast_matchers::MatchFinder::MatchResult &Result) override; 44 45 private: 46 /// Semicolon-separated list of fully qualified names of memory allocation 47 /// functions the check warns about. Defaults to `::malloc;::calloc`. 48 const StringRef AllocList; 49 /// Semicolon-separated list of fully qualified names of memory reallocation 50 /// functions the check warns about. Defaults to `::realloc`. 51 const StringRef ReallocList; 52 /// Semicolon-separated list of fully qualified names of memory deallocation 53 /// functions the check warns about. Defaults to `::free`. 54 const StringRef DeallocList; 55 }; 56 57 } // namespace clang::tidy::cppcoreguidelines 58 59 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_NO_MALLOC_H 60