clang-tools-extra/clang-tidy/bugprone/NondeterministicPointerIterationOrderCheck.h

   1 //=== NondeterministicPointerIterationOrderCheck.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_NONDETERMINISTIC_POINTER_ITERATION_ORDER_CHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_NONDETERMINISTIC_POINTER_ITERATION_ORDER_CHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::bugprone {
  15
  16 /// Finds nondeterministic usages of pointers in unordered containers. The
  17 /// check also finds calls to sorting-like algorithms on a container of
  18 /// pointers.
  19 ///
  20 /// For the user-facing documentation see:
  21 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/nondeterministic-pointer-iteration-order.html
  22 class NondeterministicPointerIterationOrderCheck : public ClangTidyCheck {
  23 public:
  24   NondeterministicPointerIterationOrderCheck(StringRef Name,
  25                                              ClangTidyContext *Context)
  26       : ClangTidyCheck(Name, Context) {}
  27   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  28     return LangOpts.CPlusPlus;
  29   }
  30   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  31   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  32   std::optional<TraversalKind> getCheckTraversalKind() const override {
  33     return TK_IgnoreUnlessSpelledInSource;
  34   }
  35 };
  36
  37 } // namespace clang::tidy::bugprone
  38
  39 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_NONDETERMINISTIC_POINTER_ITERATION_ORDER_CHECK_H