clang-tools-extra/clang-tidy/cppcoreguidelines/AvoidDoWhileCheck.h

   1 //===--- AvoidDoWhileCheck.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_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::cppcoreguidelines {
  15
  16 /// do-while loops are less readable than plan while loops, and can lead to
  17 /// subtle bugs.
  18 ///
  19 /// For the user-facing documentation see:
  20 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-do-while.html
  21 class AvoidDoWhileCheck : public ClangTidyCheck {
  22 public:
  23   AvoidDoWhileCheck(StringRef Name, ClangTidyContext *Context);
  24   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  25     return LangOpts.CPlusPlus;
  26   }
  27   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  28   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  29   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  30
  31 private:
  32   bool IgnoreMacros;
  33 };
  34
  35 } // namespace clang::tidy::cppcoreguidelines
  36
  37 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H