Renaming blink method names inside gmock's EXPECT_CALL macro invocation.

tools/clang/rewrite_to_chrome_style/RewriteToChromeStyle.cpp

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 //
 // Changes Blink-style names to Chrome-style names. Currently transforms:
 //   fields:
 //     int m_operationCount => int operation_count_
 //   variables (including parameters):
 //     int mySuperVariable => int my_super_variable
 //   constants:
@@ skipping 26 matching lines @@
 using namespace clang::ast_matchers;
 using clang::tooling::CommonOptionsParser;
 using clang::tooling::Replacement;
 using llvm::StringRef;
 
 namespace {
 
 const char kBlinkFieldPrefix[] = "m_";
 const char kBlinkStaticMemberPrefix[] = "s_";
 const char kGeneratedFileRegex[] = "^gen/|/gen/";
+const char kGMockMethodNamePrefix[] = "gmock_";
+const int kGMockMaxArgOffset = 400;  // ~8 lines of backtracking.
+const char kGMockExpectCallArgName[] = "call";
+const char kGMockExpectCallFilename[] =
+    "testing/gmock/include/gmock/gmock-spec-builders.h";
 
 template <typename MatcherType, typename NodeType>
 bool IsMatching(const MatcherType& matcher,
                 const NodeType& node,
                 clang::ASTContext& context) {
   return !match(matcher, node, context).empty();
 }
 
 const clang::ast_matchers::internal::
     VariadicDynCastAllOfMatcher<clang::Expr, clang::UnresolvedMemberExpr>
@@ skipping 15 matching lines @@
   return Node.isInstance();
 }
 
 AST_MATCHER_P(clang::FunctionTemplateDecl,
               templatedDecl,
               clang::ast_matchers::internal::Matcher<clang::FunctionDecl>,
               InnerMatcher) {
   return InnerMatcher.matches(*Node.getTemplatedDecl(), Finder, Builder);
 }
 
+// Matches a CXXMethodDecl of a method declared via MOCK_METHODx macro if such
+// method mocks a method matched by the InnerMatcher.  For example if "foo"
+// matcher matches "interfaceMethod", then mocksMethod(foo()) will match
+// "gmock_interfaceMethod" declared by MOCK_METHOD_x(interfaceMethod).
+AST_MATCHER_P(clang::CXXMethodDecl,
+              mocksMethod,
+              clang::ast_matchers::internal::Matcher<clang::CXXMethodDecl>,
+              InnerMatcher) {
+  if (!Node.getDeclName().isIdentifier())
+    return false;
+
+  llvm::StringRef method_name = Node.getName();
+  if (!method_name.startswith(kGMockMethodNamePrefix))
+    return false;
+
+  llvm::StringRef mocked_method_name =
+      method_name.substr(strlen(kGMockMethodNamePrefix));
+  for (const auto& potentially_mocked_method : Node.getParent()->methods()) {
+    if (!potentially_mocked_method->isVirtual())
+      continue;
+
+    clang::DeclarationName decl_name = potentially_mocked_method->getDeclName();
+    if (!decl_name.isIdentifier() ||
+        potentially_mocked_method->getName() != mocked_method_name)
+      continue;
+    if (potentially_mocked_method->getNumParams() != Node.getNumParams())
+      continue;
+
+    if (InnerMatcher.matches(*potentially_mocked_method, Finder, Builder))
+      return true;
+  }
+
+  return false;
+}
+
 // If |InnerMatcher| matches |top|, then the returned matcher will match:
 // - |top::function|
 // - |top::Class::method|
 // - |top::internal::Class::method|
 AST_MATCHER_P(
     clang::NestedNameSpecifier,
     hasTopLevelPrefix,
     clang::ast_matchers::internal::Matcher<clang::NestedNameSpecifier>,
     InnerMatcher) {
   const clang::NestedNameSpecifier* NodeToMatch = &Node;
@@ skipping 578 matching lines @@
 template <>
 struct TargetNodeTraits<clang::UnresolvedUsingValueDecl> {
   static clang::SourceLocation GetLoc(
       const clang::UnresolvedUsingValueDecl& decl) {
     return decl.getNameInfo().getLoc();
   }
   static const char* GetName() { return "decl"; }
   static const char* GetType() { return "UnresolvedUsingValueDecl"; }
 };
 
+bool JumpAboveMacroScratchSpace(const clang::SourceManager& source_manager,
+                                clang::SourceLocation* loc) {
+  if (loc->isMacroID()) {
+    // Try to jump "above" the scratch buffer if |loc| is inside
+    // token##Concatenation.
+    const int kMaxJumps = 5;
+    bool verified_out_of_scratch_space = false;
+    for (int i = 0; i < kMaxJumps && !verified_out_of_scratch_space; i++) {
+      clang::SourceLocation spell = source_manager.getSpellingLoc(*loc);
+      verified_out_of_scratch_space =
+          source_manager.getBufferName(spell) != "<scratch space>";
+      if (!verified_out_of_scratch_space)
+        *loc = source_manager.getImmediateMacroCallerLoc(*loc);
+    }
+    if (!verified_out_of_scratch_space)
+      return false;
+  }
+
+  return true;
+}
+
+llvm::StringRef GetActualText(const clang::ASTContext& context,
+                              const clang::SourceManager& source_manager,
+                              clang::SourceLocation loc,
+                              size_t length,
+                              clang::CharSourceRange* out_range) {

[dcheng, 2017/01/06 06:58:45]

Stylistically, I'm not a fan of optional output arguments. When I see this, it
feels like a function is doing "too much". This is similar to my earlier
feedback about GenerateReplacement().

[Łukasz Anforowicz, 2017/01/07 01:16:29]

I've inlined GetActualText back into the only caller that remained after
addressing your other piece of feedback / after using PPCallbacks.

+  clang::SourceLocation spell = source_manager.getSpellingLoc(loc);
+  clang::CharSourceRange range = clang::CharSourceRange::getCharRange(
+      spell, spell.getLocWithOffset(length));
+
+  if (out_range)
+    *out_range = range;
+
+  return clang::Lexer::getSourceText(range, source_manager,
+                                     context.getLangOpts());
+}
+
 template <typename TargetNode>
 class RewriterBase : public MatchFinder::MatchCallback {
  public:
   explicit RewriterBase(std::set<Replacement>* replacements)
       : replacements_(replacements) {}
 
   const TargetNode& GetTargetNode(const MatchFinder::MatchResult& result) {
     const TargetNode* target_node = result.Nodes.getNodeAs<TargetNode>(
         TargetNodeTraits<TargetNode>::GetName());
     assert(target_node);
     return *target_node;
   }
 
   bool GenerateReplacement(const MatchFinder::MatchResult& result,
                            clang::SourceLocation loc,
                            llvm::StringRef old_name,
                            std::string new_name,
                            Replacement* replacement) {
     const clang::ASTContext& context = *result.Context;
     const clang::SourceManager& source_manager = *result.SourceManager;
 
-    if (loc.isMacroID()) {
-      // Try to jump "above" the scratch buffer if |loc| is inside
-      // token##Concatenation.
-      const int kMaxJumps = 5;
-      bool verified_out_of_scratch_space = false;
-      for (int i = 0; i < kMaxJumps && !verified_out_of_scratch_space; i++) {
-        clang::SourceLocation spell = source_manager.getSpellingLoc(loc);
-        verified_out_of_scratch_space =
-            source_manager.getBufferName(spell) != "<scratch space>";
-        if (!verified_out_of_scratch_space)
-          loc = source_manager.getImmediateMacroCallerLoc(loc);
-      }
-      if (!verified_out_of_scratch_space)
-        return false;
-    }
+    if (!JumpAboveMacroScratchSpace(source_manager, &loc))
+      return false;
 
     // If the edit affects only the first character of the identifier, then
     // narrow down the edit to only this single character.  This is important
     // for dealing with toFooBar -> ToFooBar method renaming when the method
     // name is built using macro token concatenation like to##macroArgument - in
     // this case we should only rewrite "t" -> "T" and leave "o##macroArgument"
     // untouched.
     llvm::StringRef expected_old_text = old_name;
     llvm::StringRef new_text = new_name;
     if (loc.isMacroID() && expected_old_text.substr(1) == new_text.substr(1)) {
       expected_old_text = expected_old_text.substr(0, 1);
       new_text = new_text.substr(0, 1);
     }
-    clang::SourceLocation spell = source_manager.getSpellingLoc(loc);
-    clang::CharSourceRange range = clang::CharSourceRange::getCharRange(
-        spell, spell.getLocWithOffset(expected_old_text.size()));
 
     // We need to ensure that |actual_old_text| is the same as
     // |expected_old_text| - it can be different if |actual_old_text| contains
     // a macro argument (see DEFINE_WITH_TOKEN_CONCATENATION2 in
     // macros-original.cc testcase).
-    StringRef actual_old_text = clang::Lexer::getSourceText(
-        range, source_manager, context.getLangOpts());
+    clang::CharSourceRange range;
+    StringRef actual_old_text = GetActualText(context, source_manager, loc,
+                                              expected_old_text.size(), &range);
     if (actual_old_text != expected_old_text)
       return false;
 
     if (replacement)
       *replacement = Replacement(source_manager, range, new_text);
+
     return true;
   }
 
+  virtual clang::SourceLocation GetTargetLoc(
+      const MatchFinder::MatchResult& result) {
+    return TargetNodeTraits<TargetNode>::GetLoc(GetTargetNode(result));
+  }
+
   void AddReplacement(const MatchFinder::MatchResult& result,
                       llvm::StringRef old_name,
                       std::string new_name) {
     if (old_name == new_name)
       return;
 
-    clang::SourceLocation loc =
-        TargetNodeTraits<TargetNode>::GetLoc(GetTargetNode(result));
+    clang::SourceLocation loc = GetTargetLoc(result);
+    if (loc.isInvalid())
+      return;
 
     Replacement replacement;
     if (!GenerateReplacement(result, loc, old_name, new_name, &replacement))
       return;
 
     replacements_->insert(std::move(replacement));
     edit_tracker_.Add(*result.SourceManager, loc, old_name, new_name);
   }
 
   const EditTracker& edit_tracker() const { return edit_tracker_; }
 
  private:
   std::set<Replacement>* const replacements_;
   EditTracker edit_tracker_;
 };
 
 template <typename DeclNode, typename TargetNode>
 class DeclRewriterBase : public RewriterBase<TargetNode> {
  public:
   using Base = RewriterBase<TargetNode>;
 
   explicit DeclRewriterBase(std::set<Replacement>* replacements)
       : Base(replacements) {}
 
-  void run(const MatchFinder::MatchResult& result) override {
+  const DeclNode* GetDecl(const MatchFinder::MatchResult& result) {
     const DeclNode* decl = result.Nodes.getNodeAs<DeclNode>("decl");
     assert(decl);
+    return decl;
+  }
+
+  void run(const MatchFinder::MatchResult& result) override {
+    const DeclNode* decl = GetDecl(result);
     llvm::StringRef old_name = decl->getName();
 
     // Return early if there's no name to be renamed.
     if (!decl->getIdentifier())
       return;
 
     // Get the new name.
     std::string new_name;
     if (!GetNameForDecl(*decl, *result.Context, new_name))
       return;  // If false, the name was not suitable for renaming.
@@ skipping 35 matching lines @@
 using EnumConstantDeclRefRewriter =
     DeclRewriterBase<clang::EnumConstantDecl, clang::DeclRefExpr>;
 
 using UnresolvedLookupRewriter =
     DeclRewriterBase<clang::NamedDecl, clang::UnresolvedLookupExpr>;
 using UnresolvedMemberRewriter =
     DeclRewriterBase<clang::NamedDecl, clang::UnresolvedMemberExpr>;
 
 using UsingDeclRewriter = DeclRewriterBase<clang::UsingDecl, clang::NamedDecl>;
 
+class GMockMemberRewriter
+    : public DeclRewriterBase<clang::CXXMethodDecl, clang::MemberExpr> {
+ public:
+  using Base = DeclRewriterBase<clang::CXXMethodDecl, clang::MemberExpr>;
+
+  explicit GMockMemberRewriter(std::set<Replacement>* replacements)
+      : Base(replacements) {}
+
+  clang::SourceLocation GetTargetLoc(
+      const MatchFinder::MatchResult& result) override {
+    const clang::SourceManager& source_manager = *result.SourceManager;
+    const clang::ASTContext& context = *result.Context;
+    const clang::CXXMethodDecl* decl = GetDecl(result);
+    llvm::StringRef old_name = decl->getName();
+
+    // This is the location of gmock_##MockedMethod identifier.
+    clang::SourceLocation target_loc = Base::GetTargetLoc(result);
+    if (!JumpAboveMacroScratchSpace(source_manager, &target_loc))
+      return clang::SourceLocation();
+
+    // Find |macro_arg_loc| that points at |methodName| in
+    // EXPECT_CALL(obj, methodName(...)).
+    clang::SourceLocation macro_arg_loc;
+    for (int offset = 0; offset > -kGMockMaxArgOffset; offset--) {
+      macro_arg_loc = target_loc.getLocWithOffset(offset);
+
+      // Check if |macro_arg_loc| contains the mocked method name.
+      llvm::StringRef actual_text_of_macro_arg = GetActualText(
+          context, source_manager, macro_arg_loc, old_name.size(), nullptr);
+      if (actual_text_of_macro_arg != old_name)
+        continue;
+
+      // Location inside macro definition where the macro argument is expanded.
+      clang::SourceLocation macro_param_expansion_loc;
+      if (!source_manager.isMacroArgExpansion(macro_arg_loc,
+                                              &macro_param_expansion_loc))
+        continue;
+
+      // Check if |macro_param_expansion_loc| points here:
+      // testing/gmock/include/gmock/gmock-spec-builders.h:1844:20:
+      // 1843: #define GMOCK_EXPECT_CALL_IMPL_(obj, call) \
+      // 1844:     ((obj).gmock_##call).InternalExpectedAt(__FILE__, __LINE_...
+      //                          ^ here
+      // 1845: #define EXPECT_CALL(obj, call) GMOCK_EXPECT_CALL_IMPL_(obj, c...
+      clang::SourceLocation spell_loc =
+          source_manager.getSpellingLoc(macro_param_expansion_loc);
+      StringRef filename = source_manager.getFilename(spell_loc);
+      if (!filename.endswith(kGMockExpectCallFilename))
+        continue;
+
+      StringRef actual_text_of_macro_param_name =
+          GetActualText(context, source_manager, macro_param_expansion_loc,
+                        strlen(kGMockExpectCallArgName), nullptr);
+      if (actual_text_of_macro_param_name != kGMockExpectCallArgName)
+        continue;
+
+      // Found it!
+      return macro_arg_loc;
+    }
+
+    llvm::errs() << "Couldn't rewrite GMock's EXPECT_CALL at "
+                 << target_loc.printToString(source_manager) << "\n";
+    return clang::SourceLocation();
+  }
+};
+
 clang::DeclarationName GetUnresolvedName(
     const clang::UnresolvedMemberExpr& expr) {
   return expr.getMemberName();
 }
 
 clang::DeclarationName GetUnresolvedName(
     const clang::DependentScopeDeclRefExpr& expr) {
   return expr.getDeclName();
 }
 
@@ skipping 302 matching lines @@
           // same method.
           is_blink_method));
   MethodDeclRewriter method_decl_rewriter(&replacements);
   match_finder.addMatcher(method_decl_matcher, &method_decl_rewriter);
 
   // Method references in a non-member context ========
   // Given
   //   S s;
   //   s.g();
   //   void (S::*p)() = &S::g;
-  // matches |&S::g| but not |s.g()|.
+  // matches |&S::g| but not |s.g|.
   auto method_ref_matcher = id(
       "expr", declRefExpr(to(method_decl_matcher),
                           // Ignore template substitutions.
                           unless(hasAncestor(substNonTypeTemplateParmExpr()))));
 
   MethodRefRewriter method_ref_rewriter(&replacements);
   match_finder.addMatcher(method_ref_matcher, &method_ref_rewriter);
 
   // Method references in a member context ========
   // Given
   //   S s;
   //   s.g();
   //   void (S::*p)() = &S::g;
-  // matches |s.g()| but not |&S::g|.
+  // matches |s.g| but not |&S::g|.
   auto method_member_matcher =
       id("expr", memberExpr(member(method_decl_matcher)));
 
   MethodMemberRewriter method_member_rewriter(&replacements);
   match_finder.addMatcher(method_member_matcher, &method_member_rewriter);
 
   // Initializers ========
   // Given
   //   struct S {
   //     int x;
@@ skipping 148 matching lines @@
   //   };
   // matches |T::foo| and |x.bar|.
   auto cxx_dependent_scope_member_expr_matcher =
       expr(id("expr", cxxDependentScopeMemberExpr(
                           hasMemberFromType(blink_qual_type_matcher))));
   CXXDependentScopeMemberExprRewriter cxx_dependent_scope_member_expr_rewriter(
       &replacements);
   match_finder.addMatcher(cxx_dependent_scope_member_expr_matcher,
                           &cxx_dependent_scope_member_expr_rewriter);
 
+  // GMock calls lookup ========
+  // Given
+  //   EXPECT_CALL(obj, myMethod(...))
+  // will match obj.gmock_myMethod(...) call generated by the macro
+  // (but only if it mocks a Blink method).
+  auto gmock_member_matcher =
+      id("expr", memberExpr(hasDeclaration(
+                     decl(cxxMethodDecl(mocksMethod(method_decl_matcher))))));
+  GMockMemberRewriter gmock_member_rewriter(&replacements);
+  match_finder.addMatcher(gmock_member_matcher, &gmock_member_rewriter);
+
+  // Run all the matchers.
   std::unique_ptr<clang::tooling::FrontendActionFactory> factory =
       clang::tooling::newFrontendActionFactory(&match_finder);
   int result = tool.run(factory.get());
   if (result != 0)
     return result;
 
   // Supplemental data for the Blink rename rebase helper.
   // TODO(dcheng): There's a lot of match rewriters missing from this list.
   llvm::outs() << "==== BEGIN TRACKED EDITS ====\n";
   field_decl_rewriter.edit_tracker().SerializeTo("var", llvm::outs());
   var_decl_rewriter.edit_tracker().SerializeTo("var", llvm::outs());
   enum_member_decl_rewriter.edit_tracker().SerializeTo("enu", llvm::outs());
   function_decl_rewriter.edit_tracker().SerializeTo("fun", llvm::outs());
   method_decl_rewriter.edit_tracker().SerializeTo("fun", llvm::outs());
   llvm::outs() << "==== END TRACKED EDITS ====\n";
 
   // Serialization format is documented in tools/clang/scripts/run_tool.py
   llvm::outs() << "==== BEGIN EDITS ====\n";
   for (const auto& r : replacements) {
     std::string replacement_text = r.getReplacementText().str();
     std::replace(replacement_text.begin(), replacement_text.end(), '\n', '\0');
     llvm::outs() << "r:::" << r.getFilePath() << ":::" << r.getOffset()
                  << ":::" << r.getLength() << ":::" << replacement_text << "\n";
   }
   llvm::outs() << "==== END EDITS ====\n";
 
   return 0;
 }