[llvm] 8fd8ff1 - [StringExtras] Rename SubsequentDelim to ListSeparator

[Kazu Hirata via llvm-commits]

Author: Kazu Hirata
Date: 2021-01-15T21:00:56-08:00
New Revision: 8fd8ff1f67e4919954162ccf5f0e9b5e9c2d53fb

URL: https://github.com/llvm/llvm-project/commit/8fd8ff1f67e4919954162ccf5f0e9b5e9c2d53fb
DIFF: https://github.com/llvm/llvm-project/commit/8fd8ff1f67e4919954162ccf5f0e9b5e9c2d53fb.diff

LOG: [StringExtras] Rename SubsequentDelim to ListSeparator

This patch renames SubsequentDelim to ListSeparator to clarify the
purpose of the class.

Differential Revision: https://reviews.llvm.org/D94649

Added: 
    

Modified: 
    llvm/include/llvm/ADT/StringExtras.h
    llvm/lib/CodeGen/MachineBasicBlock.cpp
    llvm/unittests/ADT/StringExtrasTest.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/ADT/StringExtras.h b/llvm/include/llvm/ADT/StringExtras.h
index fe5c5967a2cf..10596cf82398 100644
--- a/llvm/include/llvm/ADT/StringExtras.h
+++ b/llvm/include/llvm/ADT/StringExtras.h
@@ -470,22 +470,22 @@ inline std::string join_items(Sep Separator, Args &&... Items) {
 /// list from a loop like so:
 ///
 /// \code
-///   SubsequentDelim SD;
+///   ListSeparator SD;
 ///   for (auto &I : C)
 ///     OS << SD << I.getName();
 /// \end
-class SubsequentDelim {
+class ListSeparator {
   bool First = true;
-  StringRef Delim;
+  StringRef Separator;
 
- public:
-  SubsequentDelim(StringRef Delim = ", ") : Delim(Delim) {}
+public:
+  ListSeparator(StringRef Separator = ", ") : Separator(Separator) {}
   operator StringRef() {
     if (First) {
       First = false;
       return {};
     }
-    return Delim;
+    return Separator;
   }
 };
 

diff  --git a/llvm/lib/CodeGen/MachineBasicBlock.cpp b/llvm/lib/CodeGen/MachineBasicBlock.cpp
index fded4b15e67b..b4187af02975 100644
--- a/llvm/lib/CodeGen/MachineBasicBlock.cpp
+++ b/llvm/lib/CodeGen/MachineBasicBlock.cpp
@@ -353,9 +353,9 @@ void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST,
     if (Indexes) OS << '\t';
     // Don't indent(2), align with previous line attributes.
     OS << "; predecessors: ";
-    SubsequentDelim SD;
+    ListSeparator LS;
     for (auto *Pred : predecessors())
-      OS << SD << printMBBReference(*Pred);
+      OS << LS << printMBBReference(*Pred);
     OS << '\n';
     HasLineAttributes = true;
   }
@@ -364,9 +364,9 @@ void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST,
     if (Indexes) OS << '\t';
     // Print the successors
     OS.indent(2) << "successors: ";
-    SubsequentDelim SD;
+    ListSeparator LS;
     for (auto I = succ_begin(), E = succ_end(); I != E; ++I) {
-      OS << SD << printMBBReference(**I);
+      OS << LS << printMBBReference(**I);
       if (!Probs.empty())
         OS << '('
            << format("0x%08" PRIx32, getSuccProbability(I).getNumerator())
@@ -375,10 +375,10 @@ void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST,
     if (!Probs.empty() && IsStandalone) {
       // Print human readable probabilities as comments.
       OS << "; ";
-      SubsequentDelim SD;
+      ListSeparator LS;
       for (auto I = succ_begin(), E = succ_end(); I != E; ++I) {
         const BranchProbability &BP = getSuccProbability(I);
-        OS << SD << printMBBReference(**I) << '('
+        OS << LS << printMBBReference(**I) << '('
            << format("%.2f%%",
                      rint(((double)BP.getNumerator() / BP.getDenominator()) *
                           100.0 * 100.0) /
@@ -395,9 +395,9 @@ void MachineBasicBlock::print(raw_ostream &OS, ModuleSlotTracker &MST,
     if (Indexes) OS << '\t';
     OS.indent(2) << "liveins: ";
 
-    SubsequentDelim SD;
+    ListSeparator LS;
     for (const auto &LI : liveins()) {
-      OS << SD << printReg(LI.PhysReg, TRI);
+      OS << LS << printReg(LI.PhysReg, TRI);
       if (!LI.LaneMask.all())
         OS << ":0x" << PrintLaneMask(LI.LaneMask);
     }

diff  --git a/llvm/unittests/ADT/StringExtrasTest.cpp b/llvm/unittests/ADT/StringExtrasTest.cpp
index 97a5f946a216..afc9a0136b81 100644
--- a/llvm/unittests/ADT/StringExtrasTest.cpp
+++ b/llvm/unittests/ADT/StringExtrasTest.cpp
@@ -216,16 +216,16 @@ TEST(StringExtras, IToStr) {
   EXPECT_EQ(std::to_string(MaxInt64), itostr(MaxInt64));
 }
 
-TEST(StringExtras, SubsequentDelim) {
-  SubsequentDelim SD;
-  StringRef S = SD;
+TEST(StringExtras, ListSeparator) {
+  ListSeparator LS;
+  StringRef S = LS;
   EXPECT_EQ(S, "");
-  S = SD;
+  S = LS;
   EXPECT_EQ(S, ", ");
 
-  SubsequentDelim SD2(" ");
-  S = SD2;
+  ListSeparator LS2(" ");
+  S = LS2;
   EXPECT_EQ(S, "");
-  S = SD2;
+  S = LS2;
   EXPECT_EQ(S, " ");
 }