Generate overload IDs automatically

PiperOrigin-RevId: 869905427

Author: dmitriplotnikov

common/decl.cc

@@ -16,6 +16,7 @@
 
 #include <cstddef>
 #include <string>
+#include <string_view>
 #include <utility>
 #include <vector>
 
@@ -102,13 +103,87 @@ bool SignaturesOverlap(const OverloadDecl& lhs, const OverloadDecl& rhs) {
   return args_overlap;
 }
 
+// Recursively appends a string representation of the given `type` to `result`.
+// Type parameters are enclosed in angle brackets and separated by commas.
+void AppendTypeToOverloadId(std::string* result, const Type& type) {
+  const auto& parameters = type.GetParameters();
+  if (parameters.empty()) {
+    absl::StrAppend(result, type.name());
+  } else {
+    absl::StrAppend(result, type.name(), "<");
+    for (size_t i = 0; i < parameters.size(); ++i) {
+      AppendTypeToOverloadId(result, parameters[i]);
+      if (i < parameters.size() - 1) {
+        absl::StrAppend(result, ",");
+      }
+    }
+    absl::StrAppend(result, ">");
+  }
+}
+
+// Generates an identifier for the overload based on the function name and
+// the types of the arguments.  If `member` is true, the first argument type
+// is used as the receiver and is prepended to the function name, followed by
+// a dot.
+//
+// Examples:
+//
+//  - `foo()`
+//  - `foo(int)`
+//  - `bar.foo(int)`
+//  - `foo(int,string)`
+//  - `foo(list<int>,list<string>)`
+//  - `bar.foo(list<int>, list<opaque<A>>)`
+//
+std::string GenereateOverloadId(std::string_view function_name,
+                                const std::vector<Type>& args, bool member) {
+  std::string result;
+  result.reserve(function_name.size() + 3 + args.size() * 8);
+
+  if (member) {
+    if (!args.empty()) {
+      AppendTypeToOverloadId(&result, args[0]);
+    }
+    absl::StrAppend(&result, ".", function_name, "(");
+    for (size_t i = 1; i < args.size(); ++i) {
+      AppendTypeToOverloadId(&result, args[i]);
+      if (i < args.size() - 1) {
+        absl::StrAppend(&result, ",");
+      }
+    }
+    absl::StrAppend(&result, ")");
+  } else {
+    absl::StrAppend(&result, function_name, "(");
+    for (size_t i = 0; i < args.size(); ++i) {
+      AppendTypeToOverloadId(&result, args[i]);
+      if (i < args.size() - 1) {
+        absl::StrAppend(&result, ",");
+      }
+    }
+    absl::StrAppend(&result, ")");
+  }
+
+  return result;
+}
+
 template <typename Overload>
-void AddOverloadInternal(std::vector<OverloadDecl>& insertion_order,
+void AddOverloadInternal(std::string_view function_name,
+                         std::vector<OverloadDecl>& insertion_order,
                          OverloadDeclHashSet& overloads, Overload&& overload,
                          absl::Status& status) {
   if (!status.ok()) {
     return;
   }
+
+  if (overload.id().empty()) {
+    OverloadDecl overload_decl = overload;
+    overload_decl.set_id(GenereateOverloadId(
+        function_name, overload_decl.args(), overload_decl.member()));
+    AddOverloadInternal(function_name, insertion_order, overloads,
+                        std::move(overload_decl), status);
+    return;
+  }
+
   if (auto it = overloads.find(overload.id()); it != overloads.end()) {
     status = absl::AlreadyExistsError(
         absl::StrCat("overload already exists: ", overload.id()));
@@ -174,13 +249,13 @@ absl::flat_hash_set<std::string> OverloadDecl::GetTypeParams() const {
 
 void FunctionDecl::AddOverloadImpl(const OverloadDecl& overload,
                                    absl::Status& status) {
-  AddOverloadInternal(overloads_.insertion_order, overloads_.set, overload,
-                      status);
+  AddOverloadInternal(name_, overloads_.insertion_order, overloads_.set,
+                      overload, status);
 }
 
 void FunctionDecl::AddOverloadImpl(OverloadDecl&& overload,
                                    absl::Status& status) {
-  AddOverloadInternal(overloads_.insertion_order, overloads_.set,
+  AddOverloadInternal(name_, overloads_.insertion_order, overloads_.set,
                       std::move(overload), status);
 }
 

common/decl.h

@@ -209,6 +209,21 @@ inline bool operator!=(const OverloadDecl& lhs, const OverloadDecl& rhs) {
   return !operator==(lhs, rhs);
 }
 
+template <typename... Args>
+OverloadDecl MakeOverloadDecl(Type result, Args&&... args) {
+  OverloadDecl overload_decl;
+  // overload_decl.set_id(std::string(id));
+  overload_decl.set_result(std::move(result));
+  overload_decl.set_member(false);
+  auto& mutable_args = overload_decl.mutable_args();
+  mutable_args.reserve(sizeof...(Args));
+  (mutable_args.push_back(std::forward<Args>(args)), ...);
+  return overload_decl;
+}
+
+// Avoid this version of `MakeOverloadDecl`, it is less robust than the
+// version that automatically generates a descriptive overload id at the time
+// the overload is added to the function declaration.
 template <typename... Args>
 OverloadDecl MakeOverloadDecl(absl::string_view id, Type result,
                               Args&&... args) {
@@ -222,6 +237,20 @@ OverloadDecl MakeOverloadDecl(absl::string_view id, Type result,
   return overload_decl;
 }
 
+template <typename... Args>
+OverloadDecl MakeMemberOverloadDecl(Type result, Args&&... args) {
+  OverloadDecl overload_decl;
+  overload_decl.set_result(std::move(result));
+  overload_decl.set_member(true);
+  auto& mutable_args = overload_decl.mutable_args();
+  mutable_args.reserve(sizeof...(Args));
+  (mutable_args.push_back(std::forward<Args>(args)), ...);
+  return overload_decl;
+}
+
+// Avoid this version of `MakeMemberOverloadDecl`, it is less robust than the
+// version that automatically generates a descriptive overload id at the time
+// the overload is added to the function declaration.
 template <typename... Args>
 OverloadDecl MakeMemberOverloadDecl(absl::string_view id, Type result,
                                     Args&&... args) {

common/decl_test.cc

@@ -159,6 +159,39 @@ TEST(FunctionDecl, Overloads) {
               StatusIs(absl::StatusCode::kInvalidArgument));
 }
 
+TEST(FunctionDecl, OverloadId) {
+  google::protobuf::Arena arena;
+  ASSERT_OK_AND_ASSIGN(
+      auto function_decl,
+      MakeFunctionDecl(
+          "hello", MakeOverloadDecl(DoubleType{}),
+          MakeOverloadDecl(StringType{}, StringType{}),
+          MakeOverloadDecl(IntType{}, IntType{}, UintType{}),
+          MakeOverloadDecl(
+              ListType(&arena, TypeParamType("A")),
+              MapType(&arena, TypeParamType("B"), TypeParamType("C")),
+              OpaqueType(&arena, "bar",
+                         {FunctionType(&arena, TypeParamType("D"), {})})),
+          MakeMemberOverloadDecl(IntType{}),
+          MakeMemberOverloadDecl(StringType{}, StringType{}),
+          MakeMemberOverloadDecl(StringType{}, StringType{},
+                                 ListType(&arena, BoolType{})),
+          MakeMemberOverloadDecl(StringType{}, StringType{}, BoolType{},
+                                 DynType{})));
+
+  EXPECT_THAT(
+      function_decl.overloads(),
+      ElementsAre(
+          Property(&OverloadDecl::id, "hello()"),
+          Property(&OverloadDecl::id, "hello(string)"),
+          Property(&OverloadDecl::id, "hello(int,uint)"),
+          Property(&OverloadDecl::id, "hello(map<B,C>,bar<function<D>>)"),
+          Property(&OverloadDecl::id, ".hello()"),
+          Property(&OverloadDecl::id, "string.hello()"),
+          Property(&OverloadDecl::id, "string.hello(list<bool>)"),
+          Property(&OverloadDecl::id, "string.hello(bool,dyn)")));
+}
+
 using common_internal::TypeIsAssignable;
 
 TEST(TypeIsAssignable, BoolWrapper) {