| 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::tidy::readability { |
| 16 |
|
| 17 |
/// Checks that long namespaces have a closing comment. |
| 18 |
/// |
| 19 |
/// http://llvm.org/docs/CodingStandards.html#namespace-indentation |
| 20 |
/// |
| 21 |
/// https://google.github.io/styleguide/cppguide.html#Namespaces |
| 22 |
class NamespaceCommentCheck : public ClangTidyCheck { |
| 23 |
public: |
| 24 |
NamespaceCommentCheck(StringRef Name, ClangTidyContext *Context); |
| 25 |
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override { |
| 26 |
return LangOpts.CPlusPlus; |
| 27 |
} |
| 28 |
void registerMatchers(ast_matchers::MatchFinder *Finder) override; |
| 29 |
void check(const ast_matchers::MatchFinder::MatchResult &Result) override; |
| 30 |
|
| 31 |
private: |
| 32 |
void storeOptions(ClangTidyOptions::OptionMap &Opts) override; |
| 33 |
|
| 34 |
llvm::Regex NamespaceCommentPattern; |
| 35 |
const unsigned ShortNamespaceLines; |
| 36 |
const unsigned SpacesBeforeComments; |
| 37 |
llvm::SmallVector<SourceLocation, 4> Ends; |
| 38 |
}; |
| 39 |
|
| 40 |
} // namespace clang::tidy::readability |
| 41 |
|
| 42 |
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H |