1 //===--- AssertSideEffectCheck.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_BUGPRONE_ASSERTSIDEEFFECTCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_ASSERTSIDEEFFECTCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/StringRef.h"
15 #include <string>
16 
17 namespace clang::tidy::bugprone {
18 
19 /// Finds `assert()` with side effect.
20 ///
21 /// The condition of `assert()` is evaluated only in debug builds so a
22 /// condition with side effect can cause different behavior in debug / release
23 /// builds.
24 ///
25 /// There are two options:
26 ///
27 ///   - `AssertMacros`: A comma-separated list of the names of assert macros to
28 ///     be checked.
29 ///   - `CheckFunctionCalls`: Whether to treat non-const member and non-member
30 ///     functions as they produce side effects. Disabled by default because it
31 ///     can increase the number of false positive warnings.
32 class AssertSideEffectCheck : public ClangTidyCheck {
33 public:
34   AssertSideEffectCheck(StringRef Name, ClangTidyContext *Context);
35   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
36   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
37   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
38 
39 private:
40   const bool CheckFunctionCalls;
41   const StringRef RawAssertList;
42   SmallVector<StringRef, 5> AssertMacros;
43   const std::vector<StringRef> IgnoredFunctions;
44 };
45 
46 } // namespace clang::tidy::bugprone
47 
48 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_ASSERTSIDEEFFECTCHECK_H
49