Clarify abseil formatter helpers

Signed-off-by: Anton Korobeynikov <[email protected]>
p4lang · Nov 4, 2024 · aa0d7d0 · aa0d7d0
1 parent 8cbf376
commit aa0d7d0
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/ir/id.h b/ir/id.h
@@ -67,6 +67,8 @@ struct ID : Util::IHasSourceInfo, public IHasDbPrint {
     Util::SourceInfo getSourceInfo() const override { return srcInfo; }
     cstring toString() const override { return originalName.isNullOrEmpty() ? name : originalName; }
 
+    /// Helper to simplify usage of ID in Abseil functions (e.g. StrCat / StrFormat, etc.) without
+    /// explicit string_view conversion.
     template <typename Sink>
     friend void AbslStringify(Sink &sink, const ID &id) {
         sink.Append(id.string_view());

diff --git a/ir/node.h b/ir/node.h
@@ -165,6 +165,9 @@ class Node : public virtual INode {
 
     bool operator!=(const Node &n) const { return !operator==(n); }
 
+    /// Helper to simplify usage of nodes in Abseil functions (e.g. StrCat / StrFormat, etc.)
+    /// without explicit string_view conversion. Note that this calls Node::toString() so might
+    /// not be always appropriate for user-visible messages / strings.
     template <typename Sink>
     friend void AbslStringify(Sink &sink, const IR::Node *n) {
         sink.Append(n->toString());

diff --git a/lib/cstring.h b/lib/cstring.h
@@ -309,6 +309,8 @@ class cstring {
     /// Append this many spaces after each newline (and before the first string).
     cstring indent(size_t amount) const;
 
+    /// Helper to simplify usage of cstring in Abseil functions (e.g. StrCat / StrFormat, etc.)
+    /// without explicit string_view conversion.
     template <typename Sink>
     friend void AbslStringify(Sink &sink, cstring s) {
         sink.Append(s.string_view());