xref: /freebsd/contrib/llvm-project/clang/lib/StaticAnalyzer/Checkers/SmartPtr.h (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
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 
26 /// Returns whether the smart pointer is null or not.
27 bool isNullSmartPtr(const ProgramStateRef State, const MemRegion *ThisRegion);
28 
29 } // namespace smartptr
30 } // namespace ento
31 } // namespace clang
32 
33 #endif // LLVM_CLANG_LIB_STATICANALYZER_CHECKERS_SMARTPTR_H
34