clang-tools-extra/clang-tidy/readability/AvoidUnconditionalPreprocessorIfCheck.h

   1 //===--- AvoidUnconditionalPreprocessorIfCheck.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_READABILITY_AVOIDUNCONDITIONALPREPROCESSORIFCHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDUNCONDITIONALPREPROCESSORIFCHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13
  14 namespace clang::tidy::readability {
  15
  16 /// Finds code blocks that are constantly enabled or disabled in preprocessor
  17 /// directives by analyzing `#if` conditions, such as `#if 0` and `#if 1`, etc.
  18 ///
  19 /// For the user-facing documentation see:
  20 /// http://clang.llvm.org/extra/clang-tidy/checks/readability/avoid-unconditional-preprocessor-if.html
  21 class AvoidUnconditionalPreprocessorIfCheck : public ClangTidyCheck {
  22 public:
  23   AvoidUnconditionalPreprocessorIfCheck(StringRef Name,
  24                                         ClangTidyContext *Context)
  25       : ClangTidyCheck(Name, Context) {}
  26   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  27                            Preprocessor *ModuleExpanderPP) override;
  28 };
  29
  30 } // namespace clang::tidy::readability
  31
  32 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_AVOIDUNCONDITIONALPREPROCESSORIFCHECK_H