Merge pull request #2372 from KathleenDollard/powderhouse-valueresult

Support for ValueResult as public type to carry value and location

Author: KathleenDollard

src/System.CommandLine.Subsystems.Tests/AlternateSubsystems.cs

@@ -68,11 +68,11 @@ protected override CliExit TearDown(CliExit cliExit)
         }
 
         internal class StringDirectiveSubsystem(IAnnotationProvider? annotationProvider = null)
-            : DirectiveSubsystem("other",SubsystemKind.Other, annotationProvider)
+           : DirectiveSubsystem("other",SubsystemKind.Diagram, annotationProvider)
         { }
 
         internal class BooleanDirectiveSubsystem(IAnnotationProvider? annotationProvider = null)
-            : DirectiveSubsystem("diagram", SubsystemKind.Other,  annotationProvider)
+           : DirectiveSubsystem("diagram", SubsystemKind.Diagram,  annotationProvider)
         { }
 
     }

src/System.CommandLine.Subsystems.Tests/PipelineTests.cs

@@ -173,7 +173,6 @@ public void Normal_pipeline_contains_no_subsystems()
             pipeline.Completion.Should().BeNull();
         }
 
-
         [Fact]
         public void Subsystems_can_access_each_others_data()
         {

src/System.CommandLine.Subsystems/Directives/DiagramSubsystem.cs

@@ -66,14 +66,16 @@ private static void Diagram(
             builder.Append('!');
         }
 
+// TODO: Directives
 /*
         switch (symbolResult)
         {
-            // TODO: Directives
             case DirectiveResult { Directive: not DiagramDirective }:
                 break;
+            */
 
             // TODO: This logic is deeply tied to internal types/properties. These aren't things we probably want to expose like SymbolNode. See #2349 for alternatives
+            /*
             case ArgumentResult argumentResult:
                 {
                     var includeArgumentName =

src/System.CommandLine.Subsystems/Subsystems/Annotations/ValueAnnotations.cs

@@ -0,0 +1,17 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.CommandLine.Parsing;
+
+namespace System.CommandLine.Subsystems.Annotations;
+
+/// <summary>
+/// IDs for well-known Version annotations.
+/// </summary>
+public static class ValueAnnotations
+{
+    public static string Prefix { get; } = nameof(SubsystemKind.Value);
+
+    public static AnnotationId<object> Explicit { get; } = new(Prefix, nameof(Explicit));
+    public static AnnotationId<Func<ValueResult, object?>> Calculated { get; } = new(Prefix, nameof(Calculated));
+}

src/System.CommandLine.Subsystems/Subsystems/CliSubsystem.cs

@@ -62,7 +62,7 @@ protected internal bool TryGetAnnotation<TValue>(CliSymbol symbol, AnnotationId<
     /// <param name="value">An out parameter to contain the result</param>
     /// <remarks>
     /// This value is protected because these values are always retrieved from derived classes that offer
-    /// strongly typed explicit methods, such as help having `GAetDescription(Symbol symbol, "My help descrption")` method.
+    /// strongly typed explicit methods, such as help having `GetDescription(Symbol symbol, "My help description")` method.
     /// </remarks>
     protected internal void SetAnnotation<TValue>(CliSymbol symbol, AnnotationId<TValue> id, TValue value)
     {

src/System.CommandLine.Subsystems/Subsystems/SubsystemKind.cs

@@ -8,8 +8,9 @@ public enum SubsystemKind
     Other = 0,
     Help,
     Version,
+    Value,
     ErrorReporting,
     Completion,
     Diagram,
-    Response,
+    Response
 }

src/System.CommandLine.Subsystems/ValueSubsystem.cs

@@ -0,0 +1,43 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.CommandLine.Parsing;
+using System.CommandLine.Subsystems;
+using System.CommandLine.Subsystems.Annotations;
+
+namespace System.CommandLine;
+
+public class ValueSubsystem : CliSubsystem
+{
+    private ParseResult? parseResult = null;
+
+    public ValueSubsystem(IAnnotationProvider? annotationProvider = null)
+        : base(ValueAnnotations.Prefix, SubsystemKind.Version, annotationProvider)
+    {    }
+
+    void SetExplicit(CliSymbol symbol, object value)
+        => SetAnnotation(symbol, ValueAnnotations.Explicit, value);
+    object GetExplicit(CliSymbol symbol)
+      => TryGetAnnotation(symbol, ValueAnnotations.Explicit, out var value)
+                ? value
+                : "";
+    AnnotationAccessor<object> Explicit
+      => new(this, ValueAnnotations.Explicit);
+
+    void SetCalculated(CliSymbol symbol, Func<ValueResult, object?> factory)
+        => SetAnnotation(symbol, ValueAnnotations.Calculated, factory);
+    Func<ValueResult, object?>? GetCalculatedValue(CliSymbol symbol) 
+        => TryGetAnnotation<Func<ValueResult, object?>>(symbol, ValueAnnotations.Calculated, out var value)
+                    ? value
+                    : null;
+
+    AnnotationAccessor<Func<ValueResult, object?>> Calculated
+      => new(this, ValueAnnotations.Calculated);
+
+    protected internal override bool GetIsActivated(ParseResult? parseResult)
+    {
+        this.parseResult = parseResult;
+        return true;
+    }
+}
+