clang-tidy/cppcoreguidelines/AvoidDoWhileCheck.h

0001 //===--- AvoidDoWhileCheck.h - clang-tidy -----------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013
0014 namespace clang::tidy::cppcoreguidelines {
0015
0016 /// do-while loops are less readable than plan while loops, and can lead to
0017 /// subtle bugs.
0018 ///
0019 /// For the user-facing documentation see:
0020 /// http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines/avoid-do-while.html
0021 class AvoidDoWhileCheck : public ClangTidyCheck {
0022 public:
0023   AvoidDoWhileCheck(StringRef Name, ClangTidyContext *Context);
0024   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0025     return LangOpts.CPlusPlus;
0026   }
0027   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0028   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0029   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0030
0031 private:
0032   bool IgnoreMacros;
0033 };
0034
0035 } // namespace clang::tidy::cppcoreguidelines
0036
0037 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CPPCOREGUIDELINES_AVOIDDOWHILECHECK_H