[ADT] Make escaping fn conform to coding guidelines

As noted by Adrian on llvm-commits, PrintHTMLEscaped and PrintEscaped in
StringExtras did not conform to the LLVM coding guidelines. This commit
rectifies that.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@333669 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/ADT/StringExtras.h b/include/llvm/ADT/StringExtras.h
index 9af536c..21a1bbc 100644 (file)
--- a/include/llvm/ADT/StringExtras.h
+++ b/include/llvm/ADT/StringExtras.h
@@ -251,13 +251,13 @@ inline StringRef getOrdinalSuffix(unsigned Val) {
   }
 }
 
-/// PrintEscapedString - Print each character of the specified string, escaping
-/// it if it is not printable or if it is an escape char.
-void PrintEscapedString(StringRef Name, raw_ostream &Out);
+/// Print each character of the specified string, escaping it if it is not
+/// printable or if it is an escape char.
+void printEscapedString(StringRef Name, raw_ostream &Out);
 
 /// Print each character of the specified string, escaping HTML special
 /// characters.
-void PrintHTMLEscaped(StringRef String, raw_ostream &Out);
+void printHTMLEscaped(StringRef String, raw_ostream &Out);
 
 /// printLowerCase - Print each character as lowercase if it is uppercase.
 void printLowerCase(StringRef String, raw_ostream &Out);

diff --git a/lib/CodeGen/MachineOperand.cpp b/lib/CodeGen/MachineOperand.cpp
index 2078a8b..8098333 100644 (file)
--- a/lib/CodeGen/MachineOperand.cpp
+++ b/lib/CodeGen/MachineOperand.cpp
@@ -474,7 +474,7 @@ static void printSyncScope(raw_ostream &OS, const LLVMContext &Context,
       Context.getSyncScopeNames(SSNs);
 
     OS << "syncscope(\"";
-    PrintEscapedString(SSNs[SSID], OS);
+    printEscapedString(SSNs[SSID], OS);
     OS << "\") ";
     break;
   }

diff --git a/lib/IR/AsmWriter.cpp b/lib/IR/AsmWriter.cpp
index 1212f8c..ba8db2b 100644 (file)
--- a/lib/IR/AsmWriter.cpp
+++ b/lib/IR/AsmWriter.cpp
@@ -424,7 +424,7 @@ void llvm::printLLVMNameWithoutPrefix(raw_ostream &OS, StringRef Name) {
   // Okay, we need quotes.  Output the quotes and escape any scary characters as
   // needed.
   OS << '"';
-  PrintEscapedString(Name, OS);
+  printEscapedString(Name, OS);
   OS << '"';
 }
 
@@ -1377,7 +1377,7 @@ static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
     // i8 with ConstantInt values.
     if (CA->isString()) {
       Out << "c\"";
-      PrintEscapedString(CA->getAsString(), Out);
+      printEscapedString(CA->getAsString(), Out);
       Out << '"';
       return;
     }
@@ -1610,7 +1610,7 @@ void MDFieldPrinter::printString(StringRef Name, StringRef Value,
     return;
 
   Out << FS << Name << ": \"";
-  PrintEscapedString(Value, Out);
+  printEscapedString(Value, Out);
   Out << "\"";
 }
 
@@ -2154,9 +2154,9 @@ static void WriteAsOperandInternal(raw_ostream &Out, const Value *V,
     if (IA->getDialect() == InlineAsm::AD_Intel)
       Out << "inteldialect ";
     Out << '"';
-    PrintEscapedString(IA->getAsmString(), Out);
+    printEscapedString(IA->getAsmString(), Out);
     Out << "\", \"";
-    PrintEscapedString(IA->getConstraintString(), Out);
+    printEscapedString(IA->getConstraintString(), Out);
     Out << '"';
     return;
   }
@@ -2235,7 +2235,7 @@ static void WriteAsOperandInternal(raw_ostream &Out, const Metadata *MD,
 
   if (const MDString *MDS = dyn_cast<MDString>(MD)) {
     Out << "!\"";
-    PrintEscapedString(MDS->getString(), Out);
+    printEscapedString(MDS->getString(), Out);
     Out << '"';
     return;
   }
@@ -2390,7 +2390,7 @@ void AssemblyWriter::writeSyncScope(const LLVMContext &Context,
       Context.getSyncScopeNames(SSNs);
 
     Out << " syncscope(\"";
-    PrintEscapedString(SSNs[SSID], Out);
+    printEscapedString(SSNs[SSID], Out);
     Out << "\")";
     break;
   }
@@ -2451,7 +2451,7 @@ void AssemblyWriter::writeOperandBundles(ImmutableCallSite CS) {
     FirstBundle = false;
 
     Out << '"';
-    PrintEscapedString(BU.getTagName(), Out);
+    printEscapedString(BU.getTagName(), Out);
     Out << '"';
 
     Out << '(';
@@ -2487,7 +2487,7 @@ void AssemblyWriter::printModule(const Module *M) {
 
   if (!M->getSourceFileName().empty()) {
     Out << "source_filename = \"";
-    PrintEscapedString(M->getSourceFileName(), Out);
+    printEscapedString(M->getSourceFileName(), Out);
     Out << "\"\n";
   }
 
@@ -2509,7 +2509,7 @@ void AssemblyWriter::printModule(const Module *M) {
       // We found a newline, print the portion of the asm string from the
       // last newline up to this newline.
       Out << "module asm \"";
-      PrintEscapedString(Front, Out);
+      printEscapedString(Front, Out);
       Out << "\"\n";
     } while (!Asm.empty());
   }
@@ -3143,7 +3143,7 @@ void AssemblyWriter::printGlobal(const GlobalVariable *GV) {
 
   if (GV->hasSection()) {
     Out << ", section \"";
-    PrintEscapedString(GV->getSection(), Out);
+    printEscapedString(GV->getSection(), Out);
     Out << '"';
   }
   maybePrintComdat(Out, *GV);
@@ -3327,7 +3327,7 @@ void AssemblyWriter::printFunction(const Function *F) {
     Out << " #" << Machine.getAttributeGroupSlot(Attrs.getFnAttributes());
   if (F->hasSection()) {
     Out << " section \"";
-    PrintEscapedString(F->getSection(), Out);
+    printEscapedString(F->getSection(), Out);
     Out << '"';
   }
   maybePrintComdat(Out, *F);

diff --git a/lib/IR/Attributes.cpp b/lib/IR/Attributes.cpp
index dbe38c2..01de8bb 100644 (file)
--- a/lib/IR/Attributes.cpp
+++ b/lib/IR/Attributes.cpp
@@ -419,7 +419,7 @@ std::string Attribute::getAsString(bool InAttrGrp) const {
     {
       raw_string_ostream OS(Result);
       OS << "=\"";
-      PrintEscapedString(AttrVal, OS);
+      printEscapedString(AttrVal, OS);
       OS << "\"";
     }
     return Result;

diff --git a/lib/Support/StringExtras.cpp b/lib/Support/StringExtras.cpp
index d8f8ff4..d566b72 100644 (file)
--- a/lib/Support/StringExtras.cpp
+++ b/lib/Support/StringExtras.cpp
@@ -58,7 +58,7 @@ void llvm::SplitString(StringRef Source,
   }
 }
 
-void llvm::PrintEscapedString(StringRef Name, raw_ostream &Out) {
+void llvm::printEscapedString(StringRef Name, raw_ostream &Out) {
   for (unsigned i = 0, e = Name.size(); i != e; ++i) {
     unsigned char C = Name[i];
     if (isprint(C) && C != '\\' && C != '"')
@@ -68,7 +68,7 @@ void llvm::PrintEscapedString(StringRef Name, raw_ostream &Out) {
   }
 }
 
-void llvm::PrintHTMLEscaped(StringRef String, raw_ostream &Out) {
+void llvm::printHTMLEscaped(StringRef String, raw_ostream &Out) {
   for (char C : String) {
     if (C == '&')
       Out << "&amp;";

diff --git a/tools/dsymutil/dsymutil.cpp b/tools/dsymutil/dsymutil.cpp
index 899c71e..71e24cf 100644 (file)
--- a/tools/dsymutil/dsymutil.cpp
+++ b/tools/dsymutil/dsymutil.cpp
@@ -197,19 +197,19 @@ static bool createPlistFile(llvm::StringRef Bin, llvm::StringRef BundleRoot) {
   if (!BI.OmitShortVersion()) {
     PL << "\t\t<key>CFBundleShortVersionString</key>\n";
     PL << "\t\t<string>";
-    PrintHTMLEscaped(BI.ShortVersionStr, PL);
+    printHTMLEscaped(BI.ShortVersionStr, PL);
     PL << "</string>\n";
   }
 
   PL << "\t\t<key>CFBundleVersion</key>\n";
   PL << "\t\t<string>";
-  PrintHTMLEscaped(BI.VersionStr, PL);
+  printHTMLEscaped(BI.VersionStr, PL);
   PL << "</string>\n";
 
   if (!Toolchain.empty()) {
     PL << "\t\t<key>Toolchain</key>\n";
     PL << "\t\t<string>";
-    PrintHTMLEscaped(Toolchain, PL);
+    printHTMLEscaped(Toolchain, PL);
     PL << "</string>\n";
   }
 

diff --git a/tools/llvm-cov/SourceCoverageViewHTML.cpp b/tools/llvm-cov/SourceCoverageViewHTML.cpp
index 330da8b..acb67aa 100644 (file)
--- a/tools/llvm-cov/SourceCoverageViewHTML.cpp
+++ b/tools/llvm-cov/SourceCoverageViewHTML.cpp
@@ -45,7 +45,7 @@ std::string escape(StringRef Str, const CoverageViewOptions &Opts) {
   std::string EscapedHTML;
   {
     raw_string_ostream OS{EscapedHTML};
-    PrintHTMLEscaped(TabExpandedResult, OS);
+    printHTMLEscaped(TabExpandedResult, OS);
   }
   return EscapedHTML;
 }

diff --git a/unittests/ADT/StringExtrasTest.cpp b/unittests/ADT/StringExtrasTest.cpp
index 87a4c2a..f98f388 100644 (file)
--- a/unittests/ADT/StringExtrasTest.cpp
+++ b/unittests/ADT/StringExtrasTest.cpp
@@ -93,9 +93,9 @@ TEST(StringExtrasTest, printLowerCase) {
   EXPECT_EQ("abcdefg01234.,&!~`'}\"", OS.str());
 }
 
-TEST(StringExtrasTest, PrintHTMLEscaped) {
+TEST(StringExtrasTest, printHTMLEscaped) {
   std::string str;
   raw_string_ostream OS(str);
-  PrintHTMLEscaped("ABCdef123&<>\"'", OS);
+  printHTMLEscaped("ABCdef123&<>\"'", OS);
   EXPECT_EQ("ABCdef123&amp;&lt;&gt;&quot;&apos;", OS.str());
 }