[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.

llvm-svn: 333669
This commit is contained in:
Jonas Devlieghere 2018-05-31 17:01:42 +00:00
parent 5430b73755
commit 745918ff87
8 changed files with 26 additions and 26 deletions

View File

@ -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);

View File

@ -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;
}

View File

@ -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);

View File

@ -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;

View File

@ -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;";

View File

@ -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";
}

View File

@ -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;
}

View File

@ -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());
}