clang-tools 10.0.0

NamespaceCommentCheck.h
Go to the documentation of this file.
1 //===--- NamespaceCommentCheck.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_READABILITY_NAMESPACECOMMENTCHECK_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
11
12 #include "../ClangTidyCheck.h"
13 #include "llvm/Support/Regex.h"
14
15 namespace clang {
16 namespace tidy {
17 namespace readability {
18
19 /// Checks that long namespaces have a closing comment.
20 ///
21 /// http://llvm.org/docs/CodingStandards.html#namespace-indentation
22 ///
23 /// https://google.github.io/styleguide/cppguide.html#Namespaces
24 class NamespaceCommentCheck : public ClangTidyCheck {
25 public:
26 NamespaceCommentCheck(StringRef Name, ClangTidyContext *Context);
27 void registerMatchers(ast_matchers::MatchFinder *Finder) override;
28 void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
29
30 private:
31 void storeOptions(ClangTidyOptions::OptionMap &Options) override;
32
33 llvm::Regex NamespaceCommentPattern;
34 const unsigned ShortNamespaceLines;
35 const unsigned SpacesBeforeComments;
36 llvm::SmallVector<SourceLocation, 4> Ends;
37 };
38
39 } // namespace readability
40 } // namespace tidy
41 } // namespace clang
42
43 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
clang::tidy::readability::NamespaceCommentCheck::registerMatchers
void registerMatchers(ast_matchers::MatchFinder *Finder) override
Override this to register AST matchers with Finder.
Definition: NamespaceCommentCheck.cpp:38
clang::tidy::ClangTidyCheck
Base class for all clang-tidy checks.
Definition: ClangTidyCheck.h:47
clang::tidy::readability::NamespaceCommentCheck::check
void check(const ast_matchers::MatchFinder::MatchResult &Result) override
ClangTidyChecks that register ASTMatchers should do the actual work in here.
Definition: NamespaceCommentCheck.cpp:86
clang::tidy::ClangTidyCheck::Options
OptionsView Options
Definition: ClangTidyCheck.h:184
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::readability::NamespaceCommentCheck
Checks that long namespaces have a closing comment.
Definition: NamespaceCommentCheck.h:24
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:77
clang::tidy::readability::NamespaceCommentCheck::NamespaceCommentCheck
NamespaceCommentCheck(StringRef Name, ClangTidyContext *Context)
Definition: NamespaceCommentCheck.cpp:24