Skip to content

feat/fix: support literal and single-quoted style for YAML::Binary emitting #1447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sxrzh wants to merge 2 commits into
base: master
Choose a base branch
from
+76 −7
Open

feat/fix: support literal and single-quoted style for YAML::Binary emitting #1447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d6562e
Support single-quoted and literal style for binary emitting.
sxrzh Jun 1, 2026
9e9297e
Add test for binary emitting styles.
sxrzh Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion src/emitter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,8 +976,34 @@ Emitter& Emitter::Write(const Binary& binary) {
if (!good())
return *this;

const StringFormat::value strFormat = binary.size() == 0 ?
Utils::ComputeStringFormat("", 0, m_pState->GetStringFormat(),
m_pState->CurGroupFlowType(), false) :
Utils::ComputeStringFormat("a", 1, m_pState->GetStringFormat(),
m_pState->CurGroupFlowType(), false);

if (strFormat == StringFormat::Literal)
m_pState->SetMapKeyFormat(YAML::LongKey, FmtScope::Local);

PrepareNode(EmitterNodeType::Scalar);
Utils::WriteBinary(m_stream, binary);

switch (strFormat) {
// case StringFormat::Plain: // to avoid changing the default behavior
// m_stream.write(EncodeBase64(binary.data(), binary.size()));
// break;
case StringFormat::SingleQuoted:
Utils::WriteSingleQuotedBinary(m_stream, binary);
break;
case StringFormat::Plain:
case StringFormat::DoubleQuoted:
Utils::WriteBinary(m_stream, binary);
break;
case StringFormat::Literal:
Utils::WriteLiteralBinary(m_stream, binary,
m_pState->CurIndent() + m_pState->GetIndent());
break;
}

StartedScalar();

return *this;
Expand Down
13 changes: 13 additions & 0 deletions src/emitterutils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,5 +516,18 @@ bool WriteBinary(ostream_wrapper& out, const Binary& binary) {
StringEscaping::None);
return true;
}

bool WriteLiteralBinary(ostream_wrapper& out, const Binary& binary, std::size_t indent) {
std::string encoded = EncodeBase64(binary.data(), binary.size());
WriteLiteralString(out, encoded.data(), encoded.size(), indent);
return true;
}

bool WriteSingleQuotedBinary(ostream_wrapper& out, const Binary& binary) {
std::string encoded = EncodeBase64(binary.data(), binary.size());
WriteSingleQuotedString(out, encoded.data(), encoded.size());
return true;
}

} // namespace Utils
} // namespace YAML
2 changes: 2 additions & 0 deletions src/emitterutils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ bool WriteTag(ostream_wrapper& out, const std::string& str, bool verbatim);
bool WriteTagWithPrefix(ostream_wrapper& out, const std::string& prefix,
const std::string& tag);
bool WriteBinary(ostream_wrapper& out, const Binary& binary);
bool WriteSingleQuotedBinary(ostream_wrapper& out, const Binary& binary);
bool WriteLiteralBinary(ostream_wrapper& out, const Binary& binary, std::size_t indent);
}
}

Expand Down
40 changes: 34 additions & 6 deletions test/integration/emitter_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1191,6 +1191,34 @@ TEST_F(EmitterTest, EmptyBinary) {
ExpectEmit("!!binary \"\"");
}

TEST_F(EmitterTest, BinaryStyles) {
Binary binary(reinterpret_cast<const unsigned char*>("Hello, World!"), 13);
out << BeginMap;
out << Key << "auto";
out << Value << Auto << binary;
out << Key << "single";
out << Value << SingleQuoted << binary;
out << Key << "double";
out << Value << DoubleQuoted << binary;
out << Key << "literal";
out << Value << Literal << binary;
out << Key << "literal_empty";
out << Value << Literal << Binary(reinterpret_cast<const unsigned char*>(""), 0);
out << Key << "literal_indented";
out << Value << Literal << Indent(8) << binary;
ExpectEmit(
"auto: !!binary \"SGVsbG8sIFdvcmxkIQ==\"\n"
"single: !!binary \'SGVsbG8sIFdvcmxkIQ==\'\n"
"double: !!binary \"SGVsbG8sIFdvcmxkIQ==\"\n"
"literal: !!binary |-\n"
" SGVsbG8sIFdvcmxkIQ==\n"
"literal_empty: !!binary |-\n"
"\n"
"literal_indented: !!binary |-\n"
" SGVsbG8sIFdvcmxkIQ=="
);
}

TEST_F(EmitterTest, ColonAtEndOfScalar) {
out << "a:";
ExpectEmit("\"a:\"");
Expand Down Expand Up @@ -1468,8 +1496,8 @@ TEST_F(EmitterTest, Infinity) {
out << YAML::EndMap;

ExpectEmit(
"foo: .inf\n"
"bar: .inf");
"foo: .inf\n"
"bar: .inf");
}

TEST_F(EmitterTest, NegInfinity) {
Expand All @@ -1481,8 +1509,8 @@ TEST_F(EmitterTest, NegInfinity) {
out << YAML::EndMap;

ExpectEmit(
"foo: -.inf\n"
"bar: -.inf");
"foo: -.inf\n"
"bar: -.inf");
}

TEST_F(EmitterTest, NaN) {
Expand All @@ -1494,8 +1522,8 @@ TEST_F(EmitterTest, NaN) {
out << YAML::EndMap;

ExpectEmit(
"foo: .nan\n"
"bar: .nan");
"foo: .nan\n"
"bar: .nan");
}

TEST_F(EmitterTest, ComplexFlowSeqEmbeddingAMapWithNewLine) {
Expand Down
Loading