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

   1 //===--- SuspiciousIncludeCheck.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_SUSPICIOUSINCLUDECHECK_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSINCLUDECHECK_H
  11
  12 #include "../ClangTidyCheck.h"
  13 #include "../utils/FileExtensionsUtils.h"
  14
  15 namespace clang::tidy::bugprone {
  16
  17 /// Warns on inclusion of files whose names suggest that they're implementation
  18 /// files, instead of headers. E.g:
  19 ///
  20 ///     #include "foo.cpp"  // warning
  21 ///     #include "bar.c"    // warning
  22 ///     #include "baz.h"    // no diagnostic
  23 ///
  24 /// For the user-facing documentation see:
  25 /// http://clang.llvm.org/extra/clang-tidy/checks/bugprone/suspicious-include.html
  26 class SuspiciousIncludeCheck : public ClangTidyCheck {
  27 public:
  28   SuspiciousIncludeCheck(StringRef Name, ClangTidyContext *Context);
  29   void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
  30                            Preprocessor *ModuleExpanderPP) override;
  31
  32   FileExtensionsSet HeaderFileExtensions;
  33   FileExtensionsSet ImplementationFileExtensions;
  34 };
  35
  36 } // namespace clang::tidy::bugprone
  37
  38 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_BUGPRONE_SUSPICIOUSINCLUDECHECK_H