xref: /freebsd/contrib/llvm-project/clang/lib/StaticAnalyzer/Checkers/SmartPtr.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 //=== SmartPtr.h - Tracking smart pointer state. -------------------*- 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 // Defines inter-checker API for the smart pointer modeling. It allows
10 // dependent checkers to figure out if an smart pointer is null or not.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_SMARTPTR_H
15 #define LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_SMARTPTR_H
16 
17 #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
18 
19 namespace clang {
20 namespace ento {
21 namespace smartptr {
22 
23 /// Returns true if the event call is on smart pointer.
24 bool isStdSmartPtrCall(const CallEvent &Call);
25 bool isStdSmartPtr(const CXXRecordDecl *RD);
26 bool isStdSmartPtr(const Expr *E);
27 
28 /// Returns whether the smart pointer is null or not.
29 bool isNullSmartPtr(const ProgramStateRef State, const MemRegion *ThisRegion);
30 
31 const BugType *getNullDereferenceBugType();
32 
33 } // namespace smartptr
34 } // namespace ento
35 } // namespace clang
36 
37 #endif // LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_SMARTPTR_H
38