[clang-tools-extra] r293845 - [clang-tidy] misc-argument-comment support for gmock

[Alexander Kornienko via cfe-commits]

Author: alexfh
Date: Wed Feb  1 18:37:08 2017
New Revision: 293845

URL: http://llvm.org/viewvc/llvm-project?rev=293845&view=rev
Log:
[clang-tidy] misc-argument-comment support for gmock

Modified:
    clang-tools-extra/trunk/clang-tidy/misc/ArgumentCommentCheck.cpp
    clang-tools-extra/trunk/test/clang-tidy/misc-argument-comment.cpp

Modified: clang-tools-extra/trunk/clang-tidy/misc/ArgumentCommentCheck.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/misc/ArgumentCommentCheck.cpp?rev=293845&r1=293844&r2=293845&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/misc/ArgumentCommentCheck.cpp (original)
+++ clang-tools-extra/trunk/clang-tidy/misc/ArgumentCommentCheck.cpp Wed Feb  1 18:37:08 2017
@@ -179,6 +179,21 @@ void ArgumentCommentCheck::checkCallArgs
   }
 }
 
+static const FunctionDecl *resolveMocks(const MatchFinder::MatchResult &Result,
+                                        const FunctionDecl *Func) {
+  if (auto *Method = dyn_cast<CXXMethodDecl>(Func)) {
+    if (Method->getLocation().isMacroID() &&
+        Lexer::getImmediateMacroName(Method->getLocation(),
+                                     *Result.SourceManager,
+                                     Result.Context->getLangOpts())
+            .contains("MOCK_METHOD") &&
+        Method->size_overridden_methods() != 0) {
+      Func = *Method->begin_overridden_methods();
+    }
+  }
+  return Func;
+}
+
 void ArgumentCommentCheck::check(const MatchFinder::MatchResult &Result) {
   const auto *E = Result.Nodes.getNodeAs<Expr>("expr");
   if (const auto *Call = dyn_cast<CallExpr>(E)) {
@@ -186,6 +201,8 @@ void ArgumentCommentCheck::check(const M
     if (!Callee)
       return;
 
+    Callee = resolveMocks(Result, Callee);
+
     checkCallArgs(Result.Context, Callee, Call->getCallee()->getLocEnd(),
                   llvm::makeArrayRef(Call->getArgs(), Call->getNumArgs()));
   } else {

Modified: clang-tools-extra/trunk/test/clang-tidy/misc-argument-comment.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/clang-tidy/misc-argument-comment.cpp?rev=293845&r1=293844&r2=293845&view=diff
==============================================================================
--- clang-tools-extra/trunk/test/clang-tidy/misc-argument-comment.cpp (original)
+++ clang-tools-extra/trunk/test/clang-tidy/misc-argument-comment.cpp Wed Feb  1 18:37:08 2017
@@ -53,3 +53,59 @@ void f(bool _with_underscores_);
 void ignores_underscores() {
   f(/*With_Underscores=*/false);
 }
+
+// gmock
+namespace testing {
+namespace internal {
+
+template <typename F>
+struct Function;
+
+template <typename R>
+struct Function<R()> {
+  typedef R Result;
+};
+
+template <typename R, typename A1>
+struct Function<R(A1)>
+    : Function<R()> {
+  typedef A1 Argument1;
+};
+
+template <typename R, typename A1, typename A2>
+struct Function<R(A1, A2)>
+    : Function<R(A1)> {
+  typedef A2 Argument2;
+};
+} // namespace internal
+} // namespace testing
+
+#define GMOCK_RESULT_(tn, ...) \
+    tn ::testing::internal::Function<__VA_ARGS__>::Result
+#define GMOCK_ARG_(tn, N, ...) \
+    tn ::testing::internal::Function<__VA_ARGS__>::Argument##N
+#define GMOCK_METHOD2_(tn, constness, ct, Method, ...) \
+  GMOCK_RESULT_(tn, __VA_ARGS__) ct Method( \
+      GMOCK_ARG_(tn, 1, __VA_ARGS__) gmock_a1, \
+      GMOCK_ARG_(tn, 2, __VA_ARGS__) gmock_a2) constness
+#define MOCK_METHOD2(m, ...) GMOCK_METHOD2_(, , , m, __VA_ARGS__)
+
+class Base {
+ public:
+  virtual void Method(int param_one_base, int param_two_base);
+};
+class Derived : public Base {
+ public:
+  virtual void Method(int param_one, int param_two);
+};
+class MockDerived : public Derived {
+ public:
+  MOCK_METHOD2(Method, void(int, int));
+};
+
+void test_gmock() {
+  MockDerived m;
+  m.Method(/*param_one=*/1, /*param_tw=*/2);
+// CHECK-MESSAGES: [[@LINE-1]]:29: warning: argument name 'param_tw' in comment does not match parameter name 'param_two'
+// CHECK-FIXES:   m.Method(/*param_one=*/1, /*param_two=*/2);
+}