Skip to content

Commit

Permalink
Fix region section not ignoring #region and #endregion when in a string
Browse files Browse the repository at this point in the history
When using the script editor, if the keywords #region and #endregion where
in a string and ate the start of the line, the editor would not ignore them
and count them as the actual keywords, which when folded, would only fold
until the first #endregion in a string, for example.

By checking if these keywords were in a string, this commit now ensures the
editor ignores strings and fold the section correctly.

Fixes #89115.
  • Loading branch information
RafaelRain18 committed Mar 11, 2024
1 parent 810f127 commit 8c36282
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
6 changes: 6 additions & 0 deletions scene/gui/code_edit.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1861,6 +1861,9 @@ bool CodeEdit::is_line_code_region_start(int p_line) const {
if (code_region_start_string.is_empty()) {
return false;
}
if (is_in_string(p_line) != -1) {
return false;
}
return get_line(p_line).strip_edges().begins_with(code_region_start_string);
}

Expand All @@ -1869,6 +1872,9 @@ bool CodeEdit::is_line_code_region_end(int p_line) const {
if (code_region_start_string.is_empty()) {
return false;
}
if (is_in_string(p_line) != -1) {
return false;
}
return get_line(p_line).strip_edges().begins_with(code_region_end_string);
}

Expand Down
22 changes: 22 additions & 0 deletions tests/scene/test_code_edit.h
Original file line number Diff line number Diff line change
Expand Up @@ -3048,6 +3048,28 @@ TEST_CASE("[SceneTree][CodeEdit] region folding") {
CHECK(code_edit->get_next_visible_line_offset_from(1, 1) == 4);
code_edit->unfold_line(1);
CHECK_FALSE(code_edit->is_line_folded(0));

// Region start and end tags are ignored if in a string and at the start of the line.
code_edit->clear_comment_delimiters();
code_edit->add_comment_delimiter("#", "");
code_edit->clear_string_delimiters();
code_edit->add_string_delimiter("\"", "\"");
code_edit->set_text("#region region_name1\nline2\n\"\n#region region_name2\n#endregion\n\"\n#endregion\nvisible");
CHECK(code_edit->is_line_code_region_start(0));
CHECK(code_edit->is_line_code_region_end(6));
CHECK(code_edit->can_fold_line(0));
for (int i = 1; i < 7; i++) {
if (i == 2) {
continue;
}
CHECK_FALSE(code_edit->can_fold_line(i));
}
for (int i = 0; i < 7; i++) {
CHECK_FALSE(code_edit->is_line_folded(i));
}
code_edit->fold_line(0);
CHECK(code_edit->is_line_folded(0));
CHECK(code_edit->get_next_visible_line_offset_from(1, 1) == 7);
}

memdelete(code_edit);
Expand Down

0 comments on commit 8c36282

Please sign in to comment.