clang-tools  10.0.0svn
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/HeaderFileExtensionsUtils.h"
14 
15 namespace clang {
16 namespace tidy {
17 namespace misc {
18 
19 /// Finds non-extern non-inline function and variable definitions in header
20 /// files, which can lead to potential ODR violations.
21 ///
22 /// The check supports these options:
23 /// - `UseHeaderFileExtension`: Whether to use file extension to distinguish
24 /// header files. True by default.
25 /// - `HeaderFileExtensions`: a comma-separated list of filename extensions of
26 /// header files (The filename extension should not contain "." prefix).
27 /// ",h,hh,hpp,hxx" by default.
28 /// For extension-less header files, using an empty string or leaving an
29 /// empty string between "," if there are other filename extensions.
30 ///
31 /// For the user-facing documentation see:
32 /// http://clang.llvm.org/extra/clang-tidy/checks/misc-definitions-in-headers.html
34 public:
35  DefinitionsInHeadersCheck(StringRef Name, ClangTidyContext *Context);
36  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
37  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
38  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
39 
40 private:
41  const bool UseHeaderFileExtension;
42  const std::string RawStringHeaderFileExtensions;
43  utils::HeaderFileExtensionsSet HeaderFileExtensions;
44 };
45 
46 } // namespace misc
47 } // namespace tidy
48 } // namespace clang
49 
50 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_DEFINITIONS_IN_HEADERS_H
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Base class for all clang-tidy checks.
llvm::SmallSet< llvm::StringRef, 5 > HeaderFileExtensionsSet
static constexpr llvm::StringLiteral Name
std::map< std::string, std::string > OptionMap
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
DefinitionsInHeadersCheck(StringRef Name, ClangTidyContext *Context)
Finds non-extern non-inline function and variable definitions in header files, which can lead to pote...
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.