clang-tools
9.0.0
llvm.src
tools
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/HeaderFileExtensionsUtils.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 comma-separated list of filename extensions
25
/// of header files (the filename extensions should not contain "." prefix).
26
/// "h" by default.
27
/// For extension-less header files, using an empty string or leaving an
28
/// empty string between "," if there are other filename extensions.
29
class
GlobalNamesInHeadersCheck
:
public
ClangTidyCheck
{
30
public
:
31
GlobalNamesInHeadersCheck
(StringRef
Name
,
ClangTidyContext
*Context);
32
void
storeOptions
(
ClangTidyOptions::OptionMap
&Opts)
override
;
33
void
registerMatchers
(ast_matchers::MatchFinder *Finder)
override
;
34
void
check
(
const
ast_matchers::MatchFinder::MatchResult &
Result
)
override
;
35
36
private
:
37
const
std::string RawStringHeaderFileExtensions;
38
utils::HeaderFileExtensionsSet
HeaderFileExtensions;
39
};
40
41
}
// namespace readability
42
}
// namespace google
43
}
// namespace tidy
44
}
// namespace clang
45
46
#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:29
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition:
ClangTidyCheck.h:47
clang::tidy::google::readability::GlobalNamesInHeadersCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition:
GlobalNamesInHeadersCheck.cpp:39
clang::tidy::utils::HeaderFileExtensionsSet
llvm::SmallSet< llvm::StringRef, 5 > HeaderFileExtensionsSet
Definition:
HeaderFileExtensionsUtils.h:21
Name
static constexpr llvm::StringLiteral Name
Definition:
UppercaseLiteralSuffixCheck.cpp:27
clang::tidy::ClangTidyOptions::OptionMap
std::map< std::string, std::string > OptionMap
Definition:
ClangTidyOptions.h:97
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:47
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition:
ApplyReplacements.h:27
clang::tidy::ClangTidyContext
Every ClangTidyCheck reports errors through a DiagnosticsEngine provided by this context.
Definition:
ClangTidyDiagnosticConsumer.h:99
Result
llvm::Optional< llvm::Expected< tooling::AtomicChanges > > Result
Definition:
Rename.cpp:36
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:34
Generated on Tue Aug 13 2019 18:17:06 for clang-tools by
1.8.13