Add ReferenceParser.TryParseName

Author: jahav

src/ClosedXML.Parser.Tests/ReferenceParserTests.cs

@@ -105,6 +105,47 @@ public void TryParseSheetName_cant_parse_pure_name(string text)
         Assert.False(success);
     }
 
+    [Theory]
+    [InlineData("Sheet!Name", "Sheet", "Name")]
+    [InlineData("'Hello World'!Name", "Hello World", "Name")]
+    [InlineData("' John''s World! '!Name", " John's World! ", "Name")]
+    public void TryParseName_parses_sheet_and_name(string text, string expectedSheet, string expectedName)
+    {
+        var success = ReferenceParser.TryParseName(text, out var sheet, out var name);
+        Assert.True(success);
+        Assert.Equal(expectedSheet, sheet);
+        Assert.Equal(expectedName, name);
+    }
+
+    [Fact]
+    public void TryParseName_requires_text()
+    {
+        Assert.Throws<ArgumentNullException>(() => ReferenceParser.TryParseName(null!, out _, out _));
+    }
+
+    [Theory]
+    [InlineData("Name")]
+    [InlineData("some_name")]
+    public void TryParseName_parses_name(string text)
+    {
+        var success = ReferenceParser.TryParseName(text, out var sheet, out var name);
+        Assert.True(success);
+        Assert.Null(sheet);
+        Assert.Equal(text, name);
+    }
+
+    [Theory]
+    [InlineData("A1")]
+    [InlineData("$BC$1")]
+    [InlineData("Sheet!A1")]
+    [InlineData("14")]
+    [InlineData("\"Text\"")]
+    public void TryParseName_cant_parse_anything_but_name(string text)
+    {
+        var success = ReferenceParser.TryParseName(text, out _, out _);
+        Assert.False(success);
+    }
+
     [Theory]
     [MemberData(nameof(ParseA1TestCases))]
     public void TryParseA1_unified_can_parse_local_reference(string text, ReferenceArea expectedReference)

src/ClosedXML.Parser/ReferenceParser.cs

@@ -112,6 +112,36 @@ public static bool TryParseSheetA1(string text, out string sheetName, out Refere
         return TryParseSheetA1(tokens, text, out sheetName, out area);
     }
 
+    /// <summary>
+    /// <para>
+    /// Try to parse <paramref name="text"/> as a name (e.g. <c>Name</c>) or a sheet name
+    /// (<c>Sheet!Name</c>). If the <paramref name="text"/> is only a name, the output value of the
+    /// <paramref name="sheetName"/> is <c>null</c>.
+    /// </para>
+    /// </summary>
+    /// <param name="text">Text to parse.</param>
+    /// <param name="sheetName">The unescaped name of a sheet for sheet name, <c>null</c> for a name.</param>
+    /// <param name="name">The parsed name.</param>
+    /// <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
+    [PublicAPI]
+    public static bool TryParseName(string text, out string? sheetName, out string name)
+    {
+        if (text is null)
+            throw new ArgumentNullException(nameof(text));
+
+        var tokens = RolexLexer.GetTokensA1(text.AsSpan());
+        if (tokens.Count == 2 &&
+            tokens[0].SymbolId == Token.NAME &&
+            tokens[1].SymbolId == Token.EofSymbolId)
+        {
+            sheetName = null;
+            name = text;
+            return true;
+        }
+
+        return TryParseSheetName(tokens, text, out sheetName, out name);
+    }
+
     /// <summary>
     /// Try to parse a text as a sheet name (e.g. <c>Sheet!Name</c>). Doesn't accept pure name
     /// without sheet (e.g. <c>name</c>).
@@ -127,33 +157,7 @@ public static bool TryParseSheetName(string text, out string sheetName, out stri
             throw new ArgumentNullException(nameof(text));
 
         var tokens = RolexLexer.GetTokensA1(text.AsSpan());
-        var isValid = tokens.Count switch
-        {
-            3 => tokens[0].SymbolId == Token.SINGLE_SHEET_PREFIX &&
-                 tokens[1].SymbolId == Token.NAME &&
-                 tokens[2].SymbolId == Token.EofSymbolId,
-            _ => false,
-        };
-        if (!isValid)
-        {
-            sheetName = string.Empty;
-            name = string.Empty;
-            return false;
-        }
-
-        var sheetPrefixToken = tokens[0];
-        var sheetPrefix = text.AsSpan(sheetPrefixToken.StartIndex, sheetPrefixToken.Length);
-        TokenParser.ParseSingleSheetPrefix(sheetPrefix, out int? workbookIndex, out sheetName);
-        if (workbookIndex is not null)
-        {
-            sheetName = string.Empty;
-            name = string.Empty;
-            return false;
-        }
-
-        var nameToken = tokens[1];
-        name = text.AsSpan().Slice(nameToken.StartIndex, nameToken.Length).ToString();
-        return true;
+        return TryParseSheetName(tokens, text, out sheetName, out name);
     }
 
     private static bool TryParseA1(List<Token> tokens, string text, out ReferenceArea area)
@@ -219,4 +223,35 @@ private static bool IsA1Reference(IReadOnlyList<Token> tokens)
         };
         return isValid;
     }
+
+    private static bool TryParseSheetName(List<Token> tokens, string text, out string sheetName, out string name)
+    {
+        var isValid = tokens.Count switch
+        {
+            3 => tokens[0].SymbolId == Token.SINGLE_SHEET_PREFIX &&
+                 tokens[1].SymbolId == Token.NAME &&
+                 tokens[2].SymbolId == Token.EofSymbolId,
+            _ => false,
+        };
+        if (!isValid)
+        {
+            sheetName = string.Empty;
+            name = string.Empty;
+            return false;
+        }
+
+        var sheetPrefixToken = tokens[0];
+        var sheetPrefix = text.AsSpan(sheetPrefixToken.StartIndex, sheetPrefixToken.Length);
+        TokenParser.ParseSingleSheetPrefix(sheetPrefix, out int? workbookIndex, out sheetName);
+        if (workbookIndex is not null)
+        {
+            sheetName = string.Empty;
+            name = string.Empty;
+            return false;
+        }
+
+        var nameToken = tokens[1];
+        name = text.AsSpan().Slice(nameToken.StartIndex, nameToken.Length).ToString();
+        return true;
+    }
 }