Skip to content

feat: support line wrapping for Binary in literal syntax #1455

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 3 commits into
base: master
Choose a base branch
from
+111 −10
Open

feat: support line wrapping for Binary in literal syntax #1455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdecd08
Support line wrapping for literal binary emitting.
sxrzh Jun 1, 2026
c0fb7f1
Add test for literal binary wrapping
sxrzh Jun 1, 2026
9be0b4b
fix code style and maintainability
sxrzh Jul 3, 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
5 changes: 5 additions & 0 deletions include/yaml-cpp/emitter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ class YAML_CPP_API Emitter {
// local setters
Emitter& SetLocalValue(EMITTER_MANIP value);
Emitter& SetLocalIndent(const _Indent& indent);
Emitter& SetLocalWrap(const _Wrap& wrap);
Emitter& SetLocalPrecision(const _Precision& precision);

// overloads of write
Expand Down Expand Up @@ -298,6 +299,10 @@ inline Emitter& operator<<(Emitter& emitter, _Indent indent) {
return emitter.SetLocalIndent(indent);
}

inline Emitter& operator<<(Emitter& emitter, _Wrap wrap) {
return emitter.SetLocalWrap(wrap);
}

inline Emitter& operator<<(Emitter& emitter, _Precision precision) {
return emitter.SetLocalPrecision(precision);
}
Expand Down
7 changes: 7 additions & 0 deletions include/yaml-cpp/emittermanip.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ struct _Indent {

inline _Indent Indent(int value) { return _Indent(value); }

struct _Wrap {
_Wrap(int value_) : value(value_) {}
int value;
};

inline _Wrap Wrap(int value) { return _Wrap(value); }

struct _Alias {
_Alias(const std::string& content_) : content(content_) {}
std::string content;
Expand Down
8 changes: 7 additions & 1 deletion src/emitter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,11 @@ Emitter& Emitter::SetLocalIndent(const _Indent& indent) {
return *this;
}

Emitter& Emitter::SetLocalWrap(const _Wrap& wrap) {
m_pState->SetWrap(wrap.value, FmtScope::Local);
return *this;
}

Emitter& Emitter::SetLocalPrecision(const _Precision& precision) {
if (precision.floatPrecision >= 0)
m_pState->SetFloatPrecision(precision.floatPrecision, FmtScope::Local);
Expand Down Expand Up @@ -998,7 +1003,8 @@ Emitter& Emitter::Write(const Binary& binary) {
break;
case StringFormat::Literal:
Utils::WriteLiteralBinary(m_stream, binary,
m_pState->CurIndent() + m_pState->GetIndent());
m_pState->CurIndent() + m_pState->GetIndent(),
m_pState->GetWrap());
break;
}

Expand Down
6 changes: 6 additions & 0 deletions src/emitterstate.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ EmitterState::EmitterState()
m_indent(2),
m_preCommentIndent(2),
m_postCommentIndent(1),
m_wrap(80),
m_seqFmt(Block),
m_mapFmt(Block),
m_mapKeyFmt(Auto),
Expand Down Expand Up @@ -352,6 +353,11 @@ bool EmitterState::SetPostCommentIndent(std::size_t value,
return true;
}

bool EmitterState::SetWrap(std::size_t value, FmtScope::value scope) {
_Set(m_wrap, value, scope);
return true;
}

bool EmitterState::SetFlowType(GroupType::value groupType, EMITTER_MANIP value,
FmtScope::value scope) {
switch (value) {
Expand Down
4 changes: 4 additions & 0 deletions src/emitterstate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ class EmitterState {
bool SetPostCommentIndent(std::size_t value, FmtScope::value scope);
std::size_t GetPostCommentIndent() const { return m_postCommentIndent.get(); }

bool SetWrap(std::size_t value, FmtScope::value scope);
std::size_t GetWrap() const { return m_wrap.get(); }

bool SetFlowType(GroupType::value groupType, EMITTER_MANIP value,
FmtScope::value scope);
EMITTER_MANIP GetFlowType(GroupType::value groupType) const;
Expand Down Expand Up @@ -143,6 +146,7 @@ class EmitterState {
Setting<EMITTER_MANIP> m_intFmt;
Setting<std::size_t> m_indent;
Setting<std::size_t> m_preCommentIndent, m_postCommentIndent;
Setting<std::size_t> m_wrap; // applied to literal binary
Setting<EMITTER_MANIP> m_seqFmt;
Setting<EMITTER_MANIP> m_mapFmt;
Setting<EMITTER_MANIP> m_mapKeyFmt;
Expand Down
28 changes: 20 additions & 8 deletions src/emitterutils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,21 +539,33 @@ bool WriteTagWithPrefix(ostream_wrapper& out, const std::string& prefix,

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

bool WriteLiteralBinary(ostream_wrapper& out, const Binary& binary, std::size_t indent) {
bool WriteLiteralBinary(ostream_wrapper& out, const Binary& binary, std::size_t indent, std::size_t wrap) {
std::string encoded = EncodeBase64(binary.data(), binary.size());
WriteLiteralString(out, encoded.data(), encoded.size(), indent);
return true;
std::string wrapped = "";
if (wrap) {
if (wrap <= indent) return false;
wrap -= indent;
std::size_t point = wrap;
for (std::size_t i = 0; i < encoded.size(); i++) {
if (i == point) {
wrapped += '\n';
point += wrap;
}
wrapped += encoded[i];
}
}
else
wrapped = encoded;
return WriteLiteralString(out, wrapped.data(), wrapped.size(), indent);
}

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

} // namespace Utils
Expand Down
2 changes: 1 addition & 1 deletion src/emitterutils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ 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);
bool WriteLiteralBinary(ostream_wrapper& out, const Binary& binary, std::size_t indent, std::size_t wrap);
}
}

Expand Down
61 changes: 61 additions & 0 deletions test/integration/emitter_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1219,6 +1219,67 @@ TEST_F(EmitterTest, BinaryStyles) {
);
}

TEST_F(EmitterTest, BinaryWrap) {
Binary binary(reinterpret_cast<const unsigned char*>(
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed eiusmod "
"tempor incididunt ut labore et dolore magna aliqua."
"Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris "
"nisi ut aliquip exea commodo consequat."
), 226);

out << BeginMap;
out << Key << "wrap80";
out << Value << Literal << binary;
out << Key << "wrap80_indent4";
out << Value << Literal << Indent(4) << binary;
out << Key << "wrap60";
out << Value << Literal << Wrap(60) << binary;
out << Key << "wrap60_indent4";
out << Value << Literal << Wrap(60) << Indent(4) << binary;
out << Key << "wrap_off";
out << Value << Literal << Wrap(0) << binary;
out << Key << "wrap_off_indent4";
out << Value << Literal << Wrap(0) << Indent(4) << binary;
ExpectEmit(
"wrap80: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2\n"
" VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlx\n"
" dWEuVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxsYW\n"
" 1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNvbW1vZG8gY29uc2VxdWF0Lg==\n"
"wrap80_indent4: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4g\n"
" U2VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBh\n"
" bGlxdWEuVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24g\n"
" dWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNvbW1vZG8gY29uc2VxdWF0Lg==\n"
"wrap60: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaX\n"
" Bpc2NpbmcgZWxpdC4gU2VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQg\n"
" dXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWEuVXQgZW5pbSBhZC\n"
" BtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRpb24gdWxs\n"
" YW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNvbW1vZG8gY2\n"
" 9uc2VxdWF0Lg==\n"
"wrap60_indent4: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFk\n"
" aXBpc2NpbmcgZWxpdC4gU2VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1\n"
" bnQgdXQgbGFib3JlIGV0IGRvbG9yZSBtYWduYSBhbGlxdWEuVXQgZW5p\n"
" bSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleGVyY2l0YXRp\n"
" b24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNv\n"
" bW1vZG8gY29uc2VxdWF0Lg==\n"
"wrap_off: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZW"
"xpdC4gU2VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9yZS"
"BtYWduYSBhbGlxdWEuVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBleG"
"VyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNvbW1vZG"
"8gY29uc2VxdWF0Lg==\n"
"wrap_off_indent4: !!binary |-\n"
" TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2Npbmcg"
"ZWxpdC4gU2VkIGVpdXNtb2QgdGVtcG9yIGluY2lkaWR1bnQgdXQgbGFib3JlIGV0IGRvbG9y"
"ZSBtYWduYSBhbGlxdWEuVXQgZW5pbSBhZCBtaW5pbSB2ZW5pYW0sIHF1aXMgbm9zdHJ1ZCBl"
"eGVyY2l0YXRpb24gdWxsYW1jbyBsYWJvcmlzIG5pc2kgdXQgYWxpcXVpcCBleGVhIGNvbW1v"
"ZG8gY29uc2VxdWF0Lg=="
);
}

TEST_F(EmitterTest, ColonAtEndOfScalar) {
out << "a:";
ExpectEmit("\"a:\"");
Expand Down
Loading