feature: made functionality public needed for custom tokenizers

ewoutkramer · Mar 27, 2019 · 9c2674f · 9c2674f
1 parent c8eeff8
commit 9c2674f
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 1 deletion.
diff --git a/src/Superpower/Display/Presentation.cs b/src/Superpower/Display/Presentation.cs
@@ -17,7 +17,10 @@
 
 namespace Superpower.Display
 {
-    static class Presentation
+    /// <summary>
+    /// 
+    /// </summary>
+    public static class Presentation
     {
         static string FormatKind(object kind)
         {
@@ -39,6 +42,12 @@ static TokenAttribute TryGetTokenAttribute<TKind>(TKind kind)
             return null;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <typeparam name="TKind"></typeparam>
+        /// <param name="kind"></param>
+        /// <returns></returns>
         public static string FormatExpectation<TKind>(TKind kind)
         {
             var description = TryGetTokenAttribute(kind);
@@ -53,6 +62,13 @@ public static string FormatExpectation<TKind>(TKind kind)
             return FormatKind(kind);
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <typeparam name="TKind"></typeparam>
+        /// <param name="kind"></param>
+        /// <param name="value"></param>
+        /// <returns></returns>
         public static string FormatAppearance<TKind>(TKind kind, string value)
         {
             var clipped = FormatLiteral(Friendly.Clip(value, 12));
@@ -69,6 +85,11 @@ public static string FormatAppearance<TKind>(TKind kind, string value)
 
             return $"{FormatKind(kind)} {clipped}";
         }
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="literal"></param>
+        /// <returns></returns>
         public static string FormatLiteral(char literal)
         {
             switch (literal)
@@ -137,6 +158,11 @@ public static string FormatLiteral(char literal)
             }
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="literal"></param>
+        /// <returns></returns>
         public static string FormatLiteral(string literal)
         {        
             return "`" + literal + "`";

diff --git a/src/Superpower/Model/Result.cs b/src/Superpower/Model/Result.cs
@@ -69,6 +69,20 @@ public static Result<T> Value<T>(T value, TextSpan location, TextSpan remainder)
             return new Result<T>(value, location, remainder, false);
         }
 
+        /// <summary>
+        /// Create a new Result based on another Result, supplying just the values to override
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="original"></param>
+        /// <param name="remainder"></param>
+        /// <param name="errorMessage"></param>
+        /// <param name="expectations"></param>
+        /// <returns></returns>
+        public static Result<T> Augment<T>(this Result<T> original, TextSpan? remainder, string errorMessage, string[] expectations)
+        {
+            return new Result<T>(remainder ?? original.Remainder, errorMessage ?? original.ErrorMessage, expectations ?? original.Expectations, original.Backtrack);
+        }
+
         /// <summary>
         /// Convert an empty result of one type into another.
         /// </summary>