clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h

   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   bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
  28     return LangOpts.CPlusPlus;
  29   }
  30   void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  31   void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
  32
  33 private:
  34   void storeOptions(ClangTidyOptions::OptionMap &Options) override;
  35
  36   llvm::Regex NamespaceCommentPattern;
  37   const unsigned ShortNamespaceLines;
  38   const unsigned SpacesBeforeComments;
  39   llvm::SmallVector<SourceLocation, 4> Ends;
  40 };
  41
  42 } // namespace readability
  43 } // namespace tidy
  44 } // namespace clang
  45
  46 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_NAMESPACECOMMENTCHECK_H