clang-tools 17.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/// - `HeaderFileExtensions`: a semicolon-separated list of filename
24/// extensions of header files (The filename extension should not contain
25/// "." prefix). ";h;hh;hpp;hxx" by default.
26///
27/// For extension-less header files, using an empty string or leaving an
28/// empty string between ";" if there are other filename extensions.
29///
30/// For the user-facing documentation see:
31/// http://clang.llvm.org/extra/clang-tidy/checks/misc/definitions-in-headers.html
33public:
35 bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
36 return LangOpts.CPlusPlus11;
37 }
38 void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
39 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
40 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
41
42private:
43 const bool UseHeaderFileExtension;
44 const StringRef RawStringHeaderFileExtensions;
45 utils::FileExtensionsSet HeaderFileExtensions;
46};
47
48} // namespace clang::tidy::misc
49
50#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H
Token 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.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
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
llvm::StringMap< ClangTidyValue > OptionMap