clang-tidy/readability/NamespaceCommentCheck.h

0001 //===--- NamespaceCommentCheck.h - clang-tidy -------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
0010 #define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H
0011
0012 #include "../ClangTidyCheck.h"
0013 #include "llvm/Support/Regex.h"
0014
0015 namespace clang::tidy::readability {
0016
0017 /// Checks that long namespaces have a closing comment.
0018 ///
0019 /// http://llvm.org/docs/CodingStandards.html#namespace-indentation
0020 ///
0021 /// https://google.github.io/styleguide/cppguide.html#Namespaces
0022 class NamespaceCommentCheck : public ClangTidyCheck {
0023 public:
0024   NamespaceCommentCheck(StringRef Name, ClangTidyContext *Context);
0025   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
0026     return LangOpts.CPlusPlus;
0027   }
0028   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
0029   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
0030
0031 private:
0032   void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
0033
0034   llvm::Regex NamespaceCommentPattern;
0035   const unsigned ShortNamespaceLines;
0036   const unsigned SpacesBeforeComments;
0037   llvm::SmallVector<SourceLocation, 4> Ends;
0038 };
0039
0040 } // namespace clang::tidy::readability
0041
0042 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H