Blacklisting renaming of "hash" in case of static methods and functions.

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 189 matching lines @@
   if (decl.getParent()->getQualifiedNameAsString() == class_name)
     return true;
   for (auto it = decl.begin_overridden_methods();
        it != decl.end_overridden_methods(); ++it) {
     if (IsMethodOverrideOf(**it, class_name))
       return true;
   }
   return false;
 }
 
-bool IsBlacklistedFunction(const clang::FunctionDecl& decl) {
-  // swap() functions should match the signature of std::swap for ADL tricks.
-  return decl.getName() == "swap";
+bool IsBlacklistedFunctionOrInstanceOrStaticMethodName(llvm::StringRef name) {

[dcheng, 2016/12/27 20:30:40]

I find the naming of this helper to be a bit confusing. In clang parlance, I
would expect this to just be called IsBlacklistedFunctionName().

[Łukasz Anforowicz, 2016/12/27 22:42:43]

Done.

+  // https://crbug.com/677166: Have to avoid renaming |hash| -> |Hash| to avoid
+  // colliding with a struct already named |Hash|.
+  return name == "hash";
 }
 
-bool IsBlacklistedMethodName(llvm::StringRef name) {
+bool IsBlacklistedFunctionName(llvm::StringRef name) {
+  // swap() functions should match the signature of std::swap for ADL tricks.
+  return name == "swap";

[dcheng, 2016/12/27 20:30:40]

And call this "IsBlacklistedFreeFunctionName" (since in clang parlance, methods
are a subclass of functions, while this explicitly excludes checking against
method names)

[Łukasz Anforowicz, 2016/12/27 22:42:43]

Done.

+}
+
+bool IsBlacklistedInstanceMethodName(llvm::StringRef name) {
+  if (IsBlacklistedFunctionOrInstanceOrStaticMethodName(name))
+    return true;
+
   static const char* kBlacklistedNames[] = {
-      "hash",
-      "lock", "unlock", "try_lock",
-      "begin", "end", "rbegin", "rend",
+      // We should avoid renaming the method names listed below, because
+      // 1. They are used in templated code (e.g. in <algorithms>)
+      // 2. They (begin+end) are used in range-based for syntax sugar
+      //    - for (auto x : foo) { ... }  // <- foo.begin() will be called.
+      "begin", "end", "rbegin", "rend", "lock", "unlock", "try_lock",
   };
   for (const auto& b : kBlacklistedNames) {
     if (name == b)
       return true;
   }
   return false;
 }
 
+bool IsBlacklistedStaticMethodName(llvm::StringRef name) {
+  return IsBlacklistedFunctionOrInstanceOrStaticMethodName(name);
+}
+
+bool IsBlacklistedMethodName(llvm::StringRef name) {
+  return IsBlacklistedStaticMethodName(name) ||
+         IsBlacklistedInstanceMethodName(name);
+}
+
+bool IsBlacklistedFunction(const clang::FunctionDecl& decl) {
+  clang::StringRef name = decl.getName();
+  return IsBlacklistedFunctionOrInstanceOrStaticMethodName(name) ||
+         IsBlacklistedFunctionName(name);
+}
+
 bool IsBlacklistedMethod(const clang::CXXMethodDecl& decl) {
+  clang::StringRef name = decl.getName();
   if (decl.isStatic())
-    return false;
+    return IsBlacklistedStaticMethodName(name);
 
-  clang::StringRef name = decl.getName();
-  if (IsBlacklistedMethodName(name))
-      return true;
+  if (IsBlacklistedInstanceMethodName(name))
+    return true;
 
   // Subclasses of InspectorAgent will subclass "disable()" from both blink and
   // from gen/, which is problematic, but DevTools folks don't want to rename
   // it or split this up. So don't rename it at all.
   if (name.equals("disable") &&
       IsMethodOverrideOf(decl, "blink::InspectorAgent"))
     return true;
 
   return false;
 }
@@ skipping 1049 matching lines @@
   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;
 }