clang-tidy/misc/DefinitionsInHeadersCheck.h

0001 //===--- DefinitionsInHeadersCheck.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_MISC_DEFINITIONS_IN_HEADERS_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "../utils/FileExtensionsUtils.h"
0014
0015 namespace clang::tidy::misc {
0016
0017 /// Finds non-extern non-inline function and variable definitions in header
0018 /// files, which can lead to potential ODR violations.
0019 ///
0020 /// The check supports these options:
0021 ///   - `UseHeaderFileExtension`: Whether to use file extension to distinguish
0022 ///     header files. True by default.
0023 ///
0024 /// For the user-facing documentation see:
0025 /// http://clang.llvm.org/extra/clang-tidy/checks/misc/definitions-in-headers.html
0026 class DefinitionsInHeadersCheck : public ClangTidyCheck {
0027 public:
0028   DefinitionsInHeadersCheck(StringRef Name, ClangTidyContext *Context);
0029   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0030     return LangOpts.CPlusPlus11;
0031   }
0032   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0033   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0034
0035 private:
0036   FileExtensionsSet HeaderFileExtensions;
0037 };
0038
0039 } // namespace clang::tidy::misc
0040
0041 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H