1 //===--- NamespaceCommentCheck.cpp - clang-tidy ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "NamespaceCommentCheck.h"
11 #include "clang/AST/ASTContext.h"
12 #include "clang/ASTMatchers/ASTMatchers.h"
13 #include "clang/Lex/Lexer.h"
14 #include "llvm/ADT/StringExtras.h"
15 
16 using namespace clang::ast_matchers;
17 
18 namespace clang {
19 namespace tidy {
20 namespace readability {
21 
22 NamespaceCommentCheck::NamespaceCommentCheck(StringRef Name,
23                                              ClangTidyContext *Context)
24     : ClangTidyCheck(Name, Context),
25       NamespaceCommentPattern("^/[/*] *(end (of )?)? *(anonymous|unnamed)? *"
26                               "namespace( +([a-zA-Z0-9_]+))?\\.? *(\\*/)?$",
27                               llvm::Regex::IgnoreCase),
28       ShortNamespaceLines(Options.get("ShortNamespaceLines", 1u)),
29       SpacesBeforeComments(Options.get("SpacesBeforeComments", 1u)) {}
30 
31 void NamespaceCommentCheck::storeOptions(ClangTidyOptions::OptionMap &Opts) {
32   Options.store(Opts, "ShortNamespaceLines", ShortNamespaceLines);
33   Options.store(Opts, "SpacesBeforeComments", SpacesBeforeComments);
34 }
35 
36 void NamespaceCommentCheck::registerMatchers(MatchFinder *Finder) {
37   Finder->addMatcher(namespaceDecl().bind("namespace"), this);
38 }
39 
40 bool locationsInSameFile(const SourceManager &Sources, SourceLocation Loc1,
41                          SourceLocation Loc2) {
42   return Loc1.isFileID() && Loc2.isFileID() &&
43          Sources.getFileID(Loc1) == Sources.getFileID(Loc2);
44 }
45 
46 std::string getNamespaceComment(const NamespaceDecl *ND, bool InsertLineBreak) {
47   std::string Fix = "// namespace";
48   if (!ND->isAnonymousNamespace())
49     Fix.append(" ").append(ND->getNameAsString());
50   if (InsertLineBreak)
51     Fix.append("\n");
52   return Fix;
53 }
54 
55 void NamespaceCommentCheck::check(const MatchFinder::MatchResult &Result) {
56   const NamespaceDecl *ND = Result.Nodes.getNodeAs<NamespaceDecl>("namespace");
57   const SourceManager &Sources = *Result.SourceManager;
58 
59   if (!locationsInSameFile(Sources, ND->getLocStart(), ND->getRBraceLoc()))
60     return;
61 
62   // Don't require closing comments for namespaces spanning less than certain
63   // number of lines.
64   unsigned StartLine = Sources.getSpellingLineNumber(ND->getLocStart());
65   unsigned EndLine = Sources.getSpellingLineNumber(ND->getRBraceLoc());
66   if (EndLine - StartLine + 1 <= ShortNamespaceLines)
67     return;
68 
69   // Find next token after the namespace closing brace.
70   SourceLocation AfterRBrace = ND->getRBraceLoc().getLocWithOffset(1);
71   SourceLocation Loc = AfterRBrace;
72   Token Tok;
73   // Skip whitespace until we find the next token.
74   while (Lexer::getRawToken(Loc, Tok, Sources, Result.Context->getLangOpts())) {
75     Loc = Loc.getLocWithOffset(1);
76   }
77   if (!locationsInSameFile(Sources, ND->getRBraceLoc(), Loc))
78     return;
79 
80   bool NextTokenIsOnSameLine = Sources.getSpellingLineNumber(Loc) == EndLine;
81   // If we insert a line comment before the token in the same line, we need
82   // to insert a line break.
83   bool NeedLineBreak = NextTokenIsOnSameLine && Tok.isNot(tok::eof);
84 
85   // Try to find existing namespace closing comment on the same line.
86   if (Tok.is(tok::comment) && NextTokenIsOnSameLine) {
87     StringRef Comment(Sources.getCharacterData(Loc), Tok.getLength());
88     SmallVector<StringRef, 7> Groups;
89     if (NamespaceCommentPattern.match(Comment, &Groups)) {
90       StringRef NamespaceNameInComment = Groups.size() > 5 ? Groups[5] : "";
91       StringRef Anonymous = Groups.size() > 3 ? Groups[3] : "";
92 
93       // Check if the namespace in the comment is the same.
94       if ((ND->isAnonymousNamespace() && NamespaceNameInComment.empty()) ||
95           (ND->getNameAsString() == NamespaceNameInComment &&
96            Anonymous.empty())) {
97         // FIXME: Maybe we need a strict mode, where we always fix namespace
98         // comments with different format.
99         return;
100       }
101 
102       // Otherwise we need to fix the comment.
103       NeedLineBreak = Comment.startswith("/*");
104       CharSourceRange OldCommentRange = CharSourceRange::getCharRange(
105           SourceRange(Loc, Loc.getLocWithOffset(Tok.getLength())));
106       diag(Loc, "namespace closing comment refers to a wrong namespace '%0'")
107           << NamespaceNameInComment
108           << FixItHint::CreateReplacement(
109                  OldCommentRange, getNamespaceComment(ND, NeedLineBreak));
110       return;
111     }
112 
113     // This is not a recognized form of a namespace closing comment.
114     // Leave line comment on the same line. Move block comment to the next line,
115     // as it can be multi-line or there may be other tokens behind it.
116     if (Comment.startswith("//"))
117       NeedLineBreak = false;
118   }
119 
120   std::string NamespaceName =
121       ND->isAnonymousNamespace()
122           ? "anonymous namespace"
123           : ("namespace '" + ND->getNameAsString() + "'");
124 
125   diag(AfterRBrace, "%0 not terminated with a closing comment")
126       << NamespaceName
127       << FixItHint::CreateInsertion(AfterRBrace,
128                                     std::string(SpacesBeforeComments, ' ') +
129                                         getNamespaceComment(ND, NeedLineBreak));
130   diag(ND->getLocation(), "%0 starts here", DiagnosticIDs::Note)
131       << NamespaceName;
132 }
133 
134 } // namespace readability
135 } // namespace tidy
136 } // namespace clang
137