Replace deprecated public Fmt methods with calls to Formatter::Format.

PiperOrigin-RevId: 703132251

Author: dplassgit

xls/dslx/fmt/ast_fmt.cc

@@ -59,6 +59,8 @@
 namespace xls::dslx {
 namespace {
 
+// Forward decls.
+DocRef Fmt(const Expr& n, const Comments& comments, DocArena& arena);
 DocRef FmtBlockedExprLeader(const Expr& e, const Comments& comments,
                             DocArena& arena);
 
@@ -1730,8 +1732,16 @@ DocRef FmtBlockedExprLeader(const Expr& e, const Comments& comments,
   }
 }
 
+DocRef Fmt(const Expr& n, const Comments& comments, DocArena& arena) {
+  return FmtExpr(n, comments, arena, /*suppress_parens=*/false);
+}
+
 }  // namespace
 
+DocRef Formatter::Format(const Expr& n) {
+  return FmtExpr(n, comments_, arena_, /*suppress_parens=*/false);
+}
+
 DocRef Formatter::Format(const ConstantDef& n) {
   std::vector<DocRef> leader_pieces;
   if (n.is_public()) {
@@ -2650,10 +2660,6 @@ DocRef Formatter::Format(const ModuleMember& n) {
                      n);
 }
 
-DocRef Fmt(const Expr& n, const Comments& comments, DocArena& arena) {
-  return FmtExpr(n, comments, arena, /*suppress_parens=*/false);
-}
-
 // Returns whether the given members are of the given "MemberT" and "grouped" --
 // that is, one is placed directly on the line above the other. We use this as
 // an indicator they should also be grouped in the formatted output for certain
@@ -2840,16 +2846,8 @@ DocRef Formatter::Format(const Module& n) {
   return ConcatN(arena_, pieces);
 }
 
-DocRef Fmt(const Function& n, const Comments& comments, DocArena& arena) {
-  return Formatter(comments, arena).Format(n);
-}
-
-DocRef Fmt(const Module& n, const Comments& comments, DocArena& arena) {
-  return Formatter(comments, arena).Format(n);
-}
-
-std::string LegacyAutoFmt(const Module& m, const Comments& comments,
-                          int64_t text_width) {
+static std::string AutoFmt(const Module& m, const Comments& comments,
+                           int64_t text_width) {
   DocArena arena(*m.file_table());
   Formatter formatter(comments, arena);
   DocRef ref = formatter.Format(m);
@@ -2864,7 +2862,7 @@ absl::StatusOr<std::string> AutoFmt(VirtualizableFilesystem& vfs,
   XLS_ASSIGN_OR_RETURN(
       std::unique_ptr<Module> clone,
       CloneModule(m, std::bind_front(&FormatDisabler::operator(), &disabler)));
-  return LegacyAutoFmt(*clone, comments, text_width);
+  return AutoFmt(*clone, comments, text_width);
 }
 
 absl::StatusOr<std::string> AutoFmt(VirtualizableFilesystem& vfs,
@@ -2874,7 +2872,7 @@ absl::StatusOr<std::string> AutoFmt(VirtualizableFilesystem& vfs,
   XLS_ASSIGN_OR_RETURN(
       std::unique_ptr<Module> clone,
       CloneModule(m, std::bind_front(&FormatDisabler::operator(), &disabler)));
-  return LegacyAutoFmt(*clone, comments, text_width);
+  return AutoFmt(*clone, comments, text_width);
 }
 
 // AutoFmt output should be the same as input after whitespace is eliminated

xls/dslx/fmt/ast_fmt.h

@@ -42,6 +42,7 @@ class Formatter {
   // Each `Format` method creates a pretty-printable document from the given AST
   // node `n`.
   DocRef Format(const Function& n);
+  DocRef Format(const Expr& n);
   DocRef Format(const Let& n, bool trailing_semi);
   DocRef Format(const Module& n);
   // If `trailing_semi` is true, then a trailing semicolon will also be emitted.
@@ -79,28 +80,10 @@ class Formatter {
   DocArena& arena_;
 };
 
-// Functions with this signature create a pretty printable document from the AST
-// node "n".
-
-// Deprecated; use Formatter::Format instead.
-DocRef Fmt(const Expr& n, const Comments& comments, DocArena& arena);
-
-// Deprecated; use Formatter::Format instead.
-DocRef Fmt(const Function& n, const Comments& comments, DocArena& arena);
-
-// Deprecated; use Formatter::Format instead.
-DocRef Fmt(const Module& n, const Comments& comments, DocArena& arena);
-
 inline constexpr int64_t kDslxDefaultTextWidth = 100;
 
 // Auto-formatting entry points.
 //
-// Performs a reflow-capable formatting of module `m` with standard line width.
-// This method is deprecated and will be removed soon. Use the AutoFmt method
-// below instead.
-std::string LegacyAutoFmt(const Module& m, const Comments& comments,
-                          int64_t text_width = kDslxDefaultTextWidth);
-
 // Performs a reflow-capable formatting of module `m` with standard line width,
 // but with the ability to disable formatting for specific ranges of text.
 absl::StatusOr<std::string> AutoFmt(VirtualizableFilesystem& vfs,

xls/dslx/fmt/ast_fmt_test.cc

@@ -54,7 +54,7 @@ TEST(BuiltAstFmtTest, FormatCastThatNeedsParens) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*lt, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*lt);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x as t) < x");
 }
 
@@ -63,7 +63,7 @@ TEST(BuiltAstFmtTest, FormatIndexThatNeedsParens) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*index, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*index);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x as u32[42])[i]");
 }
 
@@ -73,7 +73,7 @@ TEST(BuiltAstFmtTest, FormatTupleIndexThatNeedsParens) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*tuple_index, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*tuple_index);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x[i]).2");
 }
 
@@ -83,7 +83,7 @@ TEST(BuiltAstFmtTest, FormatSingleElementTuple) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*tuple, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*tuple);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x0,)");
 }
 
@@ -93,7 +93,7 @@ TEST(BuiltAstFmtTest, FormatShortTupleWithoutTrailingComma) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*tuple, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*tuple);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x0, x1)");
 }
 
@@ -103,7 +103,7 @@ TEST(BuiltAstFmtTest, FormatShortTupleWithTrailingComma) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*tuple, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*tuple);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x0, x1)");
 }
 
@@ -114,7 +114,7 @@ TEST(BuiltAstFmtTest, FormatLongTupleShouldAddTrailingComma) {
         MakeNElementTupleExpression(40, /*has_trailing_comma=*/true);
 
     DocArena arena(file_table);
-    DocRef doc = Fmt(*tuple, empty_comments, arena);
+    DocRef doc = Formatter(empty_comments, arena).Format(*tuple);
     EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100),
               R"((
     x0, x1, x2, x3, x4, x5, x6, x7, x8, x9, x10, x11, x12, x13, x14, x15, x16, x17, x18, x19, x20,
@@ -127,7 +127,8 @@ TEST(BuiltAstFmtTest, FormatLongTupleShouldAddTrailingComma) {
         MakeNElementTupleExpression(40, /*has_trailing_comma=*/false);
 
     DocArena arena(file_table);
-    DocRef doc = Fmt(*tuple_without_trailing_comma, empty_comments, arena);
+    DocRef doc =
+        Formatter(empty_comments, arena).Format(*tuple_without_trailing_comma);
     EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100),
               R"((
     x0, x1, x2, x3, x4, x5, x6, x7, x8, x9, x10, x11, x12, x13, x14, x15, x16, x17, x18, x19, x20,
@@ -141,7 +142,7 @@ TEST(BuiltAstFmtTest, FormatUnopThatNeedsParensOnOperand) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*unop, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*unop);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "-(x as u32)");
 }
 
@@ -150,7 +151,7 @@ TEST(BuiltAstFmtTest, FormatAttrThatNeedsParensOnOperand) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(*attr, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(*attr);
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/100), "(x * y).my_attr");
 }
 
@@ -181,7 +182,7 @@ TEST(AstFmtTest, FormatVerbatimNodeTop) {
   const Comments empty_comments = Comments::Create({});
 
   DocArena arena(file_table);
-  DocRef doc = Fmt(m, empty_comments, arena);
+  DocRef doc = Formatter(empty_comments, arena).Format(m);
 
   // Intentionally small text width, should still be formatted verbatim.
   EXPECT_EQ(PrettyPrint(arena, doc, /*text_width=*/10), verbatim_text);
@@ -233,7 +234,7 @@ class FunctionFmtTest : public testing::Test {
         f_, parser_->ParseFunction(Pos(), /*is_public=*/false, bindings_));
     Comments comments = Comments::Create(scanner_->comments());
 
-    DocRef doc = Fmt(*f_, comments, arena_);
+    DocRef doc = Formatter(comments, arena_).Format(*f_);
     std::string formatted = PrettyPrint(arena_, doc, kDslxDefaultTextWidth);
 
     std::optional<AutoFmtPostconditionViolation> maybe_violation =