Skip to content
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

Detect errors on missing flow value separators #350

Merged
merged 2 commits into from
May 27, 2024
Merged

Detect errors on missing flow value separators #350

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
20acbde
add detection of missing flow value separators
fktn-k May 26, 2024
2d7356c
added test cases for uncovered lines/branches in the deserializer
fktn-k May 26, 2024
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
106 changes: 62 additions & 44 deletions include/fkYAML/detail/input/deserializer.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,9 +361,7 @@ class basic_deserializer {
}
}

bool do_continue = true;
switch (type) {
case lexical_token_t::SEQUENCE_BLOCK_PREFIX: {
if (type == lexical_token_t::SEQUENCE_BLOCK_PREFIX) {
// a key separator preceeding block sequence entries
*mp_current_node = node_type::sequence();
apply_directive_set(*mp_current_node);
Expand All @@ -372,32 +370,12 @@ class basic_deserializer {
cur_context.line = line;
cur_context.indent = indent;
cur_context.state = context_state_t::BLOCK_SEQUENCE;
do_continue = false;
break;
}
case lexical_token_t::EXPLICIT_KEY_PREFIX:
// a key separator for a explicit block mapping key.
// defer the handling of the explicit key prefix token until the next loop.
break;
// defer checking the existence of a key separator after the scalar until a deserialize_scalar()
// call.
case lexical_token_t::NULL_VALUE:
case lexical_token_t::BOOLEAN_VALUE:
case lexical_token_t::INTEGER_VALUE:
case lexical_token_t::FLOAT_NUMBER_VALUE:
case lexical_token_t::STRING_VALUE:
// defer handling these tokens until the next loop.
case lexical_token_t::MAPPING_FLOW_BEGIN:
case lexical_token_t::SEQUENCE_FLOW_BEGIN:
break;
default: // LCOV_EXCL_LINE
break; // LCOV_EXCL_LINE
}

if (do_continue) {
continue;
}
break;
// defer checking the existence of a key separator after the following scalar until the next
// deserialize_scalar() call.
continue;
}

// handle explicit mapping key separators.
Expand Down Expand Up @@ -425,9 +403,6 @@ class basic_deserializer {

continue;
}
case lexical_token_t::VALUE_SEPARATOR:
FK_YAML_ASSERT(m_flow_context_depth > 0);
break;
// just ignore directives
case lexical_token_t::YAML_VER_DIRECTIVE:
case lexical_token_t::TAG_DIRECTIVE:
Expand Down Expand Up @@ -532,6 +507,11 @@ class basic_deserializer {
apply_node_properties(*mp_current_node);
break;
case lexical_token_t::SEQUENCE_FLOW_END: {
if (!m_needs_value_separator_or_suffix) {
throw parse_error("invalid flow sequence ending is found.", line, indent);
}
m_needs_value_separator_or_suffix = false;

--m_flow_context_depth;

// find the corresponding flow sequence beginning.
Expand Down Expand Up @@ -567,7 +547,7 @@ class basic_deserializer {
delete mp_current_node;
mp_current_node = m_context_stack.back().p_node;

add_new_key(std::move(key_node), indent, line);
add_new_key(std::move(key_node), line, indent);
break;
}

Expand All @@ -577,10 +557,15 @@ class basic_deserializer {
apply_directive_set(key_node);
mp_current_node->swap(key_node);
m_context_stack.emplace_back(line, indent, context_state_t::BLOCK_MAPPING, mp_current_node);
add_new_key(std::move(key_node), indent, line);
add_new_key(std::move(key_node), line, indent);
}
else if (!m_context_stack.empty()) {
mp_current_node = m_context_stack.back().p_node;
else {
if (!m_context_stack.empty()) {
mp_current_node = m_context_stack.back().p_node;
}
if (m_flow_context_depth > 0) {
m_needs_value_separator_or_suffix = true;
}
}

indent = lexer.get_last_token_begin_pos();
Expand Down Expand Up @@ -656,6 +641,11 @@ class basic_deserializer {
apply_node_properties(*mp_current_node);
break;
case lexical_token_t::MAPPING_FLOW_END: {
if (!m_needs_value_separator_or_suffix) {
throw parse_error("invalid flow mapping ending is found.", line, indent);
}
m_needs_value_separator_or_suffix = false;

--m_flow_context_depth;

// find the corresponding flow mapping beginning.
Expand Down Expand Up @@ -691,7 +681,7 @@ class basic_deserializer {
delete mp_current_node;
mp_current_node = m_context_stack.back().p_node;

add_new_key(std::move(key_node), indent, line);
add_new_key(std::move(key_node), line, indent);
break;
}

Expand All @@ -700,16 +690,28 @@ class basic_deserializer {
node_type key_node = node_type::mapping();
mp_current_node->swap(key_node);
m_context_stack.emplace_back(line, indent, context_state_t::BLOCK_MAPPING, mp_current_node);
add_new_key(std::move(key_node), indent, line);
add_new_key(std::move(key_node), line, indent);
}
else if (!m_context_stack.empty()) {
mp_current_node = m_context_stack.back().p_node;
else {
if (!m_context_stack.empty()) {
mp_current_node = m_context_stack.back().p_node;
}
if (m_flow_context_depth > 0) {
m_needs_value_separator_or_suffix = true;
}
}

indent = lexer.get_last_token_begin_pos();
line = lexer.get_lines_processed();
continue;
}
case lexical_token_t::VALUE_SEPARATOR:
FK_YAML_ASSERT(m_flow_context_depth > 0);
if (!m_needs_value_separator_or_suffix) {
throw parse_error("invalid value separator is found.", line, indent);
}
m_needs_value_separator_or_suffix = false;
break;
case lexical_token_t::ALIAS_PREFIX:
case lexical_token_t::NULL_VALUE:
case lexical_token_t::BOOLEAN_VALUE:
Expand Down Expand Up @@ -806,9 +808,9 @@ class basic_deserializer {

/// @brief Add new key string to the current YAML node.
/// @param key a key string to be added to the current YAML node.
/// @param indent The indentation width in the current line where the key is found.
/// @param line The line where the key is found.
void add_new_key(node_type&& key, const uint32_t indent, const uint32_t line) {
/// @param indent The indentation width in the current line where the key is found.
void add_new_key(node_type&& key, const uint32_t line, const uint32_t indent) {
if (m_flow_context_depth == 0) {
uint32_t pop_num = 0;
if (indent == 0) {
Expand Down Expand Up @@ -844,6 +846,9 @@ class basic_deserializer {
mp_current_node = m_context_stack.back().p_node;
}
}
else if (m_needs_value_separator_or_suffix) {
throw parse_error("flow mapping entry is found without separated with a comma.", line, indent);
}

if (mp_current_node->is_sequence()) {
mp_current_node->template get_value_ref<sequence_type&>().emplace_back(node_type::mapping());
Expand All @@ -864,8 +869,15 @@ class basic_deserializer {

/// @brief Assign node value to the current node.
/// @param node_value A rvalue node_type object to be assigned to the current node.
void assign_node_value(node_type&& node_value) noexcept {
void assign_node_value(node_type&& node_value, const uint32_t line, const uint32_t indent) {
if (mp_current_node->is_sequence()) {
if (m_flow_context_depth > 0) {
if (m_needs_value_separator_or_suffix) {
throw parse_error("flow sequence entry is found without separated with a comma.", line, indent);
}
m_needs_value_separator_or_suffix = true;
}

mp_current_node->template get_value_ref<sequence_type&>().emplace_back(std::move(node_value));
return;
}
Expand All @@ -875,6 +887,10 @@ class basic_deserializer {
if (m_flow_context_depth > 0 || m_context_stack.back().state != context_state_t::BLOCK_MAPPING_EXPLICIT_KEY) {
m_context_stack.pop_back();
mp_current_node = m_context_stack.back().p_node;

if (m_flow_context_depth > 0) {
m_needs_value_separator_or_suffix = true;
}
}
}

Expand Down Expand Up @@ -974,7 +990,7 @@ class basic_deserializer {
node_type node = create_scalar_node(lexer, type, indent, line);

if (mp_current_node->is_mapping()) {
add_new_key(std::move(node), indent, line);
add_new_key(std::move(node), line, indent);
return false;
}

Expand All @@ -983,7 +999,7 @@ class basic_deserializer {
if (mp_current_node->is_scalar()) {
if (line != lexer.get_lines_processed()) {
// This path is for explicit mapping key separator(:)
assign_node_value(std::move(node));
assign_node_value(std::move(node), line, indent);
if (m_context_stack.back().state != context_state_t::BLOCK_MAPPING_EXPLICIT_KEY) {
mp_current_node = m_context_stack.back().p_node;
m_context_stack.pop_back();
Expand Down Expand Up @@ -1012,10 +1028,10 @@ class basic_deserializer {
*mp_current_node = node_type::mapping();
apply_directive_set(*mp_current_node);
}
add_new_key(std::move(node), indent, line);
add_new_key(std::move(node), line, indent);
}
else {
assign_node_value(std::move(node));
assign_node_value(std::move(node), line, indent);
}
indent = lexer.get_last_token_begin_pos();
line = lexer.get_lines_processed();
Expand Down Expand Up @@ -1063,6 +1079,8 @@ class basic_deserializer {
bool m_needs_anchor_impl {false};
/// A flag to determine the need for a corresponding node with the last YAML tag.
bool m_needs_tag_impl {false};
/// A flag to determine the need for a value separator or a flow suffix to be follow.
bool m_needs_value_separator_or_suffix {false};
/// The last YAML anchor name.
string_type m_anchor_name {};
/// The last tag name.
Expand Down
Loading