ObjectDebugData: Expose a helper for formatting the @use-src comment

libyul/Object.cpp

@@ -53,16 +53,6 @@ std::string Object::toString(
  yulAssert(hasCode(), "No code");
  yulAssert(debugData, "No debug data");
 
- std::string useSrcComment;
-
- if (debugData->sourceNames)
- useSrcComment =
- "/// @use-src " +
- joinHumanReadable(ranges::views::transform(*debugData->sourceNames, [](auto&& _pair) {
- return std::to_string(_pair.first) + ":" + util::escapeAndQuoteString(*_pair.second);
- })) +
- "\n";
-
  std::string inner = "code " + AsmPrinter(
  _printingMode,
  _dialect,
@@ -74,7 +64,11 @@ std::string Object::toString(
  for (auto const& obj: subObjects)
  inner += "\n" + obj->toString(_dialect, _printingMode, _debugInfoSelection, _soliditySourceProvider);
 
- return useSrcComment + "object \"" + name + "\" {\n" + indent(inner) + "\n}";
+ return
+ debugData->formatUseSrcComment() +
+ "object \"" + name + "\" {\n" +
+ indent(inner) + "\n" +
+ "}";
 }
 
 Json Data::toJson() const
@@ -85,6 +79,21 @@ Json Data::toJson() const
  return ret;
 }
 
+std::string ObjectDebugData::formatUseSrcComment() const
+{
+ if (!sourceNames)
+ return "";
+
+ auto formatIdNamePair = [](auto&& _pair) {
+ return std::to_string(_pair.first) + ":" + util::escapeAndQuoteString(*_pair.second);
+ };
+
+ std::string serializedSourceNames = joinHumanReadable(
+ ranges::views::transform(*sourceNames, formatIdNamePair)
+ );
+ return "/// @use-src " + serializedSourceNames + "\n";
+}
+
 Json Object::toJson() const
 {
  yulAssert(hasCode(), "No code");

libyul/Object.h

@@ -84,6 +84,8 @@ struct Data: public ObjectNode
 struct ObjectDebugData
 {
  std::optional<SourceNameMap> sourceNames = {};
+
+ std::string formatUseSrcComment() const;
 };