[clang-tidy] Exclude function calls in std namespace for bugprone-argument-comment.

[gribozavr2]

clang-tools-extra/clang-tidy/bugprone/ArgumentCommentCheck.cpp

67

"Ignore APIs from the standard library, since their names are not specified by the standard, and standard library implementations in practice have to use reserved names to avoid conflicts with same-named macros."

68

Please use the isInStdNamespace() matcher instead.

68

I think there are redundant parentheses around isFromStdNamespace().

[hokein]

address comment.

[hokein]

clang-tools-extra/clang-tidy/bugprone/ArgumentCommentCheck.cpp

68

isInStdNamespace is not a same thing -- it just checks the direct DeclContext is a std namespace, e.g. std::vector::assign, the declcontext of the assign is CXXRecordDecl (vector), isInStdNamespace will return false, but we want true.

clang-tools-extra/clang-tidy/bugprone/ArgumentCommentCheck.cpp

 
 #include "../utils/LexerUtils.h"
 
 using namespace clang::ast_matchers;
 
 namespace clang {
 namespace tidy {
 namespace bugprone {
+namespace {
+AST_MATCHER(Decl, isFromStdNamespace) {
+  if (const auto *D = Node.getDeclContext()->getEnclosingNamespaceContext())
+    return D->isStdNamespace();
+  return false;
+}
+} // namespace
 
 ArgumentCommentCheck::ArgumentCommentCheck(StringRef Name,
                                            ClangTidyContext *Context)
     : ClangTidyCheck(Name, Context),
       StrictMode(Options.getLocalOrGlobal("StrictMode", false)),
       IgnoreSingleArgument(Options.get("IgnoreSingleArgument", false)),
       CommentBoolLiterals(Options.get("CommentBoolLiterals", false)),
       CommentIntegerLiterals(Options.get("CommentIntegerLiterals", false)),

 
 void ArgumentCommentCheck::registerMatchers(MatchFinder *Finder) {
   Finder->addMatcher(
       callExpr(unless(cxxOperatorCallExpr()),
                // NewCallback's arguments relate to the pointed function,
                // don't check them against NewCallback's parameter names.
                // FIXME: Make this configurable.
                unless(hasDeclaration(functionDecl(
-                   hasAnyName("NewCallback", "NewPermanentCallback")))))
+                   hasAnyName("NewCallback", "NewPermanentCallback")))),
+               // Ignore APIs from the standard library, since their names are
+               // not specified by the standard, and standard library
+               // implementations in practice have to use reserved names to
+               // avoid conflicts with same-named macros.
+               unless(hasDeclaration(isFromStdNamespace())))
+          .bind("expr"),
+      this);
+  Finder->addMatcher(
+      cxxConstructExpr(unless(hasDeclaration(isFromStdNamespace())))
           .bind("expr"),
       this);
-  Finder->addMatcher(cxxConstructExpr().bind("expr"), this);
 }
 
 static std::vector<std::pair<SourceLocation, StringRef>>
 getCommentsInRange(ASTContext *Ctx, CharSourceRange Range) {
   std::vector<std::pair<SourceLocation, StringRef>> Comments;
   auto &SM = Ctx->getSourceManager();
   std::pair<FileID, unsigned> BeginLoc = SM.getDecomposedLoc(Range.getBegin()),
                               EndLoc = SM.getDecomposedLoc(Range.getEnd());

clang-tools-extra/test/clang-tidy/checkers/bugprone-argument-comment.cpp

 // RUN: %check_clang_tidy %s bugprone-argument-comment %t
 
 // FIXME: clang-tidy should provide a -verify mode to make writing these checks
 // easier and more accurate.
 
 void ffff(int xxxx, int yyyy);
 
 void f(int x, int y);
 void g() {

 
 namespace OtherEditDistanceBelowThreshold {
 void f6(int xxx, int yyy);
 void g() { f6(/*xxy=*/0, 0); }
 // CHECK-NOTES: [[@LINE-1]]:15: warning: argument name 'xxy' in comment does not match parameter name 'xxx'
 // CHECK-NOTES: [[@LINE-3]]:13: note: 'xxx' declared here
 // CHECK-FIXES: void g() { f6(/*xxy=*/0, 0); }
 }
+
+
+namespace std {
+template <typename T>
+class vector {
+public:
+  void assign(int __n, const T &__val);
+};
+template<typename T>
+void swap(T& __a, T& __b);
+} // namespace std
+namespace ignore_std_functions {
+void test(int a, int b) {
+  std::vector<int> s;
+  // verify the check is not fired on std functions.
+  s.assign(1, /*value=*/2);
+  std::swap(a, /*num=*/b);
+}
+} // namespace ignore_std_functions