Skip to content

fix: remove unverified potential simple key when beginning parsing a literal scalar #1468

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
+59 −0
Open

fix: remove unverified potential simple key when beginning parsing a literal scalar #1468

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
061bd6f
remove unverified simple key before parsing literal scalar
sxrzh Jul 26, 2026
a1c7565
add test for literal scalar with tag
sxrzh Jul 26, 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
11 changes: 11 additions & 0 deletions src/scanner.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,17 @@ void Scanner::ScanNextToken() {
// special scalars
if (InBlockContext() && (INPUT.peek() == Keys::LiteralScalar ||
INPUT.peek() == Keys::FoldedScalar)) {
// if we begin parsing a literal scalar with an unverified potential
// simple key pushed, that may be a tag to the literal scalar, and
// should be removed to avoid wrong indentation limit
// eg:
// - !!str |
// literal
// scalar
if (!m_simpleKeys.empty() &&
m_simpleKeys.top().pKey->status == Token::UNVERIFIED) {
PopIndent();
}
return ScanBlockScalar();
}

Expand Down
48 changes: 48 additions & 0 deletions test/integration/handler_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,53 @@ TEST_F(HandlerTest, CommentOnNewlineOfMapValueWithManySpace) {
EXPECT_CALL(handler, OnDocumentEnd());
Parse("key: value\n # comment");
}

// examples from issue #1163
TEST_F(HandlerTest, LiteralScalarWithTagAndLargeIndentation) {
EXPECT_CALL(handler, OnDocumentStart(_));
EXPECT_CALL(handler, OnMapStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "?", 0, "key"));
EXPECT_CALL(handler, OnSequenceStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "tag:yaml.org,2002:str", 0, "multiple\nwords"));
EXPECT_CALL(handler, OnSequenceEnd());
EXPECT_CALL(handler, OnMapEnd());
EXPECT_CALL(handler, OnDocumentEnd());
Parse("key:\n- !!str |\n multiple\n words");
}

TEST_F(HandlerTest, LiteralScalarWithTagAndSmallIndentation_NotBlockSequence) {
EXPECT_CALL(handler, OnDocumentStart(_));
EXPECT_CALL(handler, OnMapStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "?", 0, "key"));
EXPECT_CALL(handler, OnScalar(_, "!t", 0, "multiple\nwords"));
EXPECT_CALL(handler, OnMapEnd());
EXPECT_CALL(handler, OnDocumentEnd());
Parse("key: !t |\n multiple\n words");
}

TEST_F(HandlerTest, LiteralScalarWithTagAndSmallIndentation_ApplicationTag) {
EXPECT_CALL(handler, OnDocumentStart(_));
EXPECT_CALL(handler, OnMapStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "?", 0, "key"));
EXPECT_CALL(handler, OnSequenceStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "!t", 0, "multiple\nwords"));
EXPECT_CALL(handler, OnSequenceEnd());
EXPECT_CALL(handler, OnMapEnd());
EXPECT_CALL(handler, OnDocumentEnd());
Parse("key:\n- !t |\n multiple\n words");
}

TEST_F(HandlerTest, LiteralScalarWithTagAndSmallIndentation_StandardTag) {
EXPECT_CALL(handler, OnDocumentStart(_));
EXPECT_CALL(handler, OnMapStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "?", 0, "key"));
EXPECT_CALL(handler, OnSequenceStart(_, "?", 0, EmitterStyle::Block));
EXPECT_CALL(handler, OnScalar(_, "tag:yaml.org,2002:str", 0, "multiple\nwords"));
EXPECT_CALL(handler, OnSequenceEnd());
EXPECT_CALL(handler, OnMapEnd());
EXPECT_CALL(handler, OnDocumentEnd());
Parse("key:\n- !!str |\n multiple\n words");
}

} // namespace
} // namespace YAML