1 //===--- PointerArithmeticOnPolymorphicObjectCheck.h ------------*- 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_POINTERARITHMETICONPOLYMORPHICOBJECTCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_POINTERARITHMETICONPOLYMORPHICOBJECTCHECK_H
11 
12 #include "../ClangTidyCheck.h"
13 
14 namespace clang::tidy::bugprone {
15 
16 /// Finds pointer arithmetic performed on classes that contain a
17 /// virtual function.
18 ///
19 /// For the user-facing documentation see:
20 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/pointer-arithmetic-on-polymorphic-object.html
21 class PointerArithmeticOnPolymorphicObjectCheck : public ClangTidyCheck {
22 public:
23   PointerArithmeticOnPolymorphicObjectCheck(StringRef Name,
24                                             ClangTidyContext *Context);
25   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
26   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
27   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
isLanguageVersionSupported(const LangOptions & LangOpts)28   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
29     return LangOpts.CPlusPlus;
30   }
getCheckTraversalKind()31   std::optional<TraversalKind> getCheckTraversalKind() const override {
32     return TK_IgnoreUnlessSpelledInSource;
33   }
34 
35 private:
36   const bool IgnoreInheritedVirtualFunctions;
37 };
38 
39 } // namespace clang::tidy::bugprone
40 
41 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_POINTERARITHMETICONPOLYMORPHICOBJECTCHECK_H
42