epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix handling of empty indented MiniYAML comments.

Browse Source 
An empty MiniYaml comment that was indented was previously not recognized, and instead parsed as a key named '#'. Now, indented comments are recognized as comments, which matches the behaviour for unindented lines.
This commit is contained in:
RoosterDragon
2023-12-05 19:59:59 +00:00
committed by Gustas
parent aa5b193746
commit f270cb3bde
2 changed files with 48 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
OpenRA.Game/MiniYaml.cs
View File

@@ -258,9 +258,6 @@ namespace OpenRA
} }
} }
if (parsedLines.Count > 0 && parsedLines[^1].Level < level - 1)
throw new YamlException($"Bad indent in miniyaml at {location}");
// Extract key, value, comment from line as `<key>: <value>#<comment>` // Extract key, value, comment from line as `<key>: <value>#<comment>`
// The # character is allowed in the value if escaped (\#). // The # character is allowed in the value if escaped (\#).
// Leading and trailing whitespace is always trimmed from keys. // Leading and trailing whitespace is always trimmed from keys.
@@ -282,7 +279,7 @@ namespace OpenRA
if (commentStart < 0 && line[i] == '#' && (i == 0 || line[i - 1] != '\\')) if (commentStart < 0 && line[i] == '#' && (i == 0 || line[i - 1] != '\\'))
{ {
commentStart = i + 1; commentStart = i + 1;
if (commentStart <= keyLength) if (i <= keyStart + keyLength)
keyLength = i - keyStart; keyLength = i - keyStart;
else else
valueLength = i - valueStart; valueLength = i - valueStart;
@@ -320,6 +317,9 @@ namespace OpenRA
if (!key.IsEmpty || !discardCommentsAndWhitespace) if (!key.IsEmpty || !discardCommentsAndWhitespace)
{ {
if (parsedLines.Count > 0 && parsedLines[^1].Level < level - 1)
throw new YamlException($"Bad indent in miniyaml at {location}");
while (parsedLines.Count > 0 && parsedLines[^1].Level > level) while (parsedLines.Count > 0 && parsedLines[^1].Level > level)
BuildCompletedSubNode(level); BuildCompletedSubNode(level);

45
OpenRA.Test/OpenRA.Game/MiniYamlTest.cs
View File

@@ -613,14 +613,41 @@ TestB:
# #
Parent: # comment without value Parent: # comment without value
# Indented comment node # Indented comment node
#
# Double Indented comment node
#
# Triple Indented comment node
#
First: value containing a \# character First: value containing a \# character
Second: value # node with inline comment Second: value # node with inline comment
Third: value # Third: value #
Fourth: # Fourth: #
Fifth# embedded comment:
Sixth# embedded comment: still a comment
Seventh# embedded comment: still a comment # more comment
".Replace("\r\n", "\n");
var canonicalYaml = @"
# Top level comment node
#
Parent: # comment without value
# Indented comment node
#
# Double Indented comment node
#
# Triple Indented comment node
#
First: value containing a \# character
Second: value # node with inline comment
Third: value #
Fourth: #
Fifth: # embedded comment:
Sixth: # embedded comment: still a comment
Seventh: # embedded comment: still a comment # more comment
".Replace("\r\n", "\n"); ".Replace("\r\n", "\n");
var result = MiniYaml.FromString(yaml, discardCommentsAndWhitespace: false).WriteToString(); var result = MiniYaml.FromString(yaml, discardCommentsAndWhitespace: false).WriteToString();
Assert.AreEqual(yaml, result); Assert.AreEqual(canonicalYaml, result);
} }
[TestCase(TestName = "Comments should be removed when discardCommentsAndWhitespace is false")] [TestCase(TestName = "Comments should be removed when discardCommentsAndWhitespace is false")]
@@ -628,15 +655,31 @@ Parent: # comment without value
{ {
const string Yaml = @" const string Yaml = @"
# Top level comment node # Top level comment node
#
Parent: # comment without value Parent: # comment without value
# Indented comment node # Indented comment node
#
# Double Indented comment node
#
# Triple Indented comment node
#
First: value containing a \# character First: value containing a \# character
Second: value # node with inline comment Second: value # node with inline comment
Third: value #
Fourth: #
Fifth# embedded comment:
Sixth# embedded comment: still a comment
Seventh# embedded comment: still a comment # more comment
"; ";
var strippedYaml = @"Parent: var strippedYaml = @"Parent:
First: value containing a \# character First: value containing a \# character
Second: value Second: value
Third: value
Fourth:
Fifth:
Sixth:
Seventh:
".Replace("\r\n", "\n"); ".Replace("\r\n", "\n");
var result = MiniYaml.FromString(Yaml).WriteToString(); var result = MiniYaml.FromString(Yaml).WriteToString();