clang-tools 19.0.0git
DefinitionsInHeadersCheck.h
Go to the documentation of this file.
1//===--- DefinitionsInHeadersCheck.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_MISC_DEFINITIONS_IN_HEADERS_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H
11
12#include "../ClangTidyCheck.h"
13#include "../utils/FileExtensionsUtils.h"
14
15namespace clang::tidy::misc {
16
17/// Finds non-extern non-inline function and variable definitions in header
18/// files, which can lead to potential ODR violations.
19///
20/// The check supports these options:
21/// - `UseHeaderFileExtension`: Whether to use file extension to distinguish
22/// header files. True by default.
23///
24/// For the user-facing documentation see:
25/// http://clang.llvm.org/extra/clang-tidy/checks/misc/definitions-in-headers.html
27public:
29 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
30 return LangOpts.CPlusPlus11;
31 }
32 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
33 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
34
35private:
36 FileExtensionsSet HeaderFileExtensions;
37};
38
39} // namespace clang::tidy::misc
40
41#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H
llvm::SmallString< 256U > Name
Base class for all clang-tidy checks.
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Finds non-extern non-inline function and variable definitions in header files, which can lead to pote...
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override
Override this to disable registering matchers and PP callbacks if an invalid language version is bein...
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
llvm::SmallSet< llvm::StringRef, 5 > FileExtensionsSet