clang-tools
11.0.0
clang-tools-extra
clang-tidy
google
GlobalNamesInHeadersCheck.h
Go to the documentation of this file.
1
//===--- GlobalNamesInHeadersCheck.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_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
10
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
11
12
#include "../ClangTidyCheck.h"
13
#include "../utils/FileExtensionsUtils.h"
14
15
namespace
clang
{
16
namespace
tidy {
17
namespace
google {
18
namespace
readability {
19
20
/// Flag global namespace pollution in header files.
21
/// Right now it only triggers on using declarations and directives.
22
///
23
/// The check supports these options:
24
/// - `HeaderFileExtensions`: a semicolon-separated list of filename
25
/// extensions of header files (the filename extensions should not contain
26
/// "." prefix). ";h;hh;hpp;hxx" by default.
27
///
28
/// For extension-less header files, using an empty string or leaving an
29
/// empty string between ";" if there are other filename extensions.
30
class
GlobalNamesInHeadersCheck
:
public
ClangTidyCheck
{
31
public
:
32
GlobalNamesInHeadersCheck
(StringRef
Name
,
ClangTidyContext
*Context);
33
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
34
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
35
void
check
(
const
ast_matchers::MatchFinder::MatchResult &Result)
override
;
36
37
private
:
38
const
std::string RawStringHeaderFileExtensions;
39
utils::FileExtensionsSet
HeaderFileExtensions;
40
};
41
42
}
// namespace readability
43
}
// namespace google
44
}
// namespace tidy
45
}
// namespace clang
46
47
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_GOOGLE_GLOBALNAMESINHEADERSCHECK_H
clang::tidy::google::readability::GlobalNamesInHeadersCheck
Flag global namespace pollution in header files.
Definition:
GlobalNamesInHeadersCheck.h:30
clang::tidy::google::readability::GlobalNamesInHeadersCheck::GlobalNamesInHeadersCheck
GlobalNamesInHeadersCheck(StringRef Name, ClangTidyContext *Context)
Definition:
GlobalNamesInHeadersCheck.cpp:22
clang::tidy::google::readability::GlobalNamesInHeadersCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition:
GlobalNamesInHeadersCheck.cpp:48
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:114
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:76
Name
static constexpr llvm::StringLiteral Name
Definition:
UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::google::readability::GlobalNamesInHeadersCheck::storeOptions
void storeOptions(ClangTidyOptions::OptionMap &Opts) override
Should store all options supported by this check with their current values or default values for opti...
Definition:
GlobalNamesInHeadersCheck.cpp:35
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::google::readability::GlobalNamesInHeadersCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
GlobalNamesInHeadersCheck.cpp:40
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, ClangTidyValue > OptionMap
Definition:
ClangTidyOptions.h:111
clang::tidy::utils::FileExtensionsSet
llvm::SmallSet< llvm::StringRef, 5 > FileExtensionsSet
Definition:
FileExtensionsUtils.h:22
Generated on Tue Jul 28 2020 16:14:02 for clang-tools by
1.8.16