Merge pull request #61 from active-logic/StatusRef-Refactor

Status ref refactor and unit coverage

Author: eelstork

Src/Certainties/Action.cs

@@ -23,20 +23,26 @@ public readonly partial struct action{
 
     public static loop operator - (action x) => loop._cont;
 
-    public static bool operator true  (action s)
+    // NOTE: required since `false` is implemented; there is not
+    // a known instance where this function would be called.
+    public static bool operator true(action s)
     => throw new InvOp("truehood cannot be tested (action)");
 
+    // NOTE: used in action && action
     public static bool operator false (action s) => false;
 
+    public override bool Equals(object x) => x is action;
+
+    override public int GetHashCode() => 1;
+
     #if AL_OPTIMIZE   // --------------------------------------------
 
     public static action done(ValidString reason = null) => _done;
 
     public static failure operator ! (action s) => failure._fail;
     #endif
 
-    public static implicit operator bool(action self)
-    => true;
+    public static implicit operator bool(action self) => true;
 
     public static implicit operator status(action self)
     => status._done;

Src/Certainties/Failure.cs

@@ -27,6 +27,10 @@ public readonly partial struct failure{
     public static bool operator false (failure s)
     => throw new InvOp("falsehood cannot be tested (failure)");
 
+    public override bool Equals(object x) => x is failure;
+
+    override public int GetHashCode() => -1;
+
     #if AL_OPTIMIZE   // --------------------------------------------
 
     public static failure fail(ValidString reason = null) => _fail;

Src/Certainties/Impending.cs

@@ -45,6 +45,13 @@ public static bool operator true (impending s)
     public static bool operator false(impending s)
     => throw new InvOp("Cannot test falsehood (impending)");
 
+    public override bool Equals(object x)
+    => x is impending && Equals((impending)x);
+
+    public bool Equals(in impending x) => true;
+
+    override public int GetHashCode() => ω;
+
     override public string ToString()
     => ω == -1 ? "impending.fail" : "impending.cont";
 

Src/Certainties/Loop.cs

@@ -34,6 +34,8 @@ public static bool operator true  (loop s)
     public static bool operator false (loop s)
     => throw new InvOp("falsehood cannot be tested (loop)");
 
+    override public int GetHashCode() => 0;
+
     public static implicit operator impending(loop self)
     => impending._cont;
 

Src/Certainties/Pending.cs

@@ -39,6 +39,13 @@ public static bool operator true (pending s)
 
     public static bool operator false(pending s) => s.ω !=  1;
 
+    public override bool Equals(object x)
+    => x is pending && Equals((pending)x);
+
+    public bool Equals(in pending x) => this.ω == x.ω;
+
+    override public int GetHashCode() => ω;
+
     public override string ToString()
     => ω == 0 ? "pending.cont" : "pending.done";
 

Src/Decorators/Drive.cs

@@ -13,30 +13,26 @@ namespace Active.Core{
 public class Drive : AbstractDecorator{
 
     static int uid; internal static int id => uid = ID(uid);
-    //
-    static status hold;
 
     #if !AL_OPTIMIZE
-    internal static LogData logData;
+
     protected object target;
     #endif
 
     public Gate? this[status @in, bool crit]{ get{
-        hold = @in;
+        StatusRef.hold = @in;
         return @in.running ? Eval(crit) : Bypass();
     }}
 
-    public Gate? this[bool @in, bool crit]{ get{
-        hold = @in ? status.cont() : status.fail();
-        return @in ? Eval(crit) : Bypass();
-    }}
+    public Gate? this[bool @in, bool crit]
+    => this[@in ? status.cont() : status.fail(), crit];
 
     protected Gate Eval(bool crit, ValidString reason=null)
     => new Gate(this, crit, new LogData(this, ".", reason));
 
     protected Gate? Bypass(ValidString reason=null){
         #if !AL_OPTIMIZE
-        logData = new LogData(this, target, reason);
+        SetLogData(target, reason);
         #endif
         return null;
     }
@@ -62,51 +58,13 @@ public StatusRef this[status s]{ get{
             #if !AL_OPTIMIZE
             owner.target = s.targetScope;
             #endif
-            return new StatusRef(crit ? s : hold, logData);
+            return new StatusRef(crit ? s : StatusRef.hold, logData);
         }}
 
     }
 
     // ===============================================================
 
-    public readonly struct StatusRef{
-
-         readonly status x;
-         readonly LogData logData;
-
-         internal StatusRef(status value, LogData logData)
-         { x = value; this.logData = logData; }
-
-         #if AL_OPTIMIZE
-         public static implicit operator status(StatusRef? self)
-         => ToStatus(self);
-         #else
-         public static implicit operator status(StatusRef? self)
-         => status.log ? ToStatusWithLog(self) : ToStatus(self);
-         #endif
-
-         static status ToStatus(StatusRef? self)
-         => self?.x ?? Self.hold;
-
-         #if !AL_OPTIMIZE
-         static status ToStatusWithLog(StatusRef? self){
-             if(self.HasValue){
-                 var ι = self.Value;
-                 return ι.x.ViaDecorator(
-                             ι.logData.scope,
-                             log && ι.logData.Reason());
-             }else{
-                 if(Self.logData.scope == null) throw
-                    new InvOp("Log data is null");
-                 return hold.ViaDecorator(
-                             Self.logData.scope,
-                             log && Self.logData.Reason());
-             }
-        }
-        #endif
-
-    }  // StatusRef
-
 }
 
 #if !AL_BEST_PERF

Src/Decorators/InOut.cs

@@ -7,7 +7,7 @@ namespace Active.Core{
 public class InOut : Conditional{
 
     static int uid; internal static int id => uid = ID(uid);
-    bool passing;
+    internal bool passing;
     int frame;
 
     public Gate? this[bool @in, bool @out]{ get{

Src/Decorators/Once.cs

@@ -13,14 +13,11 @@ namespace Active.Core{
 public class Once : AbstractDecorator{
 
     static int uid; internal static int id => uid = ID(uid);
-    //
-    static status hold;
     //
 	internal status state = cont();
     int frame = 0;
 
     #if !AL_OPTIMIZE
-    internal static LogData logData;
     protected object target;
     #endif
 
@@ -34,9 +31,9 @@ protected Gate Eval(ValidString reason=null)
 
     protected Gate? Bypass(ValidString reason=null){
         #if !AL_OPTIMIZE
-        logData = new LogData(this, target, reason);
+        SetLogData(target, reason);
         #endif
-        hold = state;
+        StatusRef.hold = state;
         return null;
     }
 
@@ -63,52 +60,12 @@ public StatusRef this[status s]{ get{
 
     }
 
-    // ===============================================================
-
-    public readonly struct StatusRef{
-
-         readonly status x;
-         readonly LogData logData;
-
-         internal StatusRef(status value, LogData logData)
-         { x = value; this.logData = logData; }
-
-         #if AL_OPTIMIZE
-         public static implicit operator status(StatusRef? self)
-         => ToStatus(self);
-         #else
-         public static implicit operator status(StatusRef? self)
-         => status.log ? ToStatusWithLog(self) : ToStatus(self);
-         #endif
-
-         internal static status ToStatus(StatusRef? self)
-         => self?.x ?? Once.hold;
-
-         #if !AL_OPTIMIZE
-         internal static status ToStatusWithLog(StatusRef? self){
-             if(self.HasValue){
-                 var ι = self.Value;
-                 return ι.x.ViaDecorator(
-                             ι.logData.scope,
-                             log && ι.logData.Reason());
-             }else{
-                 if(Self.logData.scope == null) throw
-                    new InvOp("Log data is null");
-                 return hold.ViaDecorator(
-                             Self.logData.scope,
-                             log && Self.logData.Reason());
-             }
-        }
-        #endif
-
-    }  // StatusRef
-
-}
+}  // Once
 
 #if !AL_BEST_PERF
 partial class Task{
 	public Self.Gate? Once([Tag] int key = -1)
-	=> store.Decorator<Self>(key, Self.id)?.pass;
+	=> store.Decorator<Self>(key, Self.id).pass;
 }
 #endif
 

Src/Decorators/Timeout.cs

@@ -9,10 +9,10 @@ public class Timeout : Conditional, Conditional.OptionalArguments{
 
     static int uid; internal static int id => uid = ID(uid);
 	public float duration = 1;
-	float stamp;
+	internal float stamp;
     int frame;
 
-	bool enabled => stamp != -1;
+	internal bool enabled => stamp != -1;
 
 	public Timeout() => stamp = time;
 
@@ -36,7 +36,7 @@ public Gate? this[float s]{ get{
 
 	override public void OnStatus(status s) => OnStatus(s.running);
 
-    void OnStatus(bool running)
+    internal void OnStatus(bool running)
 	=> stamp = enabled ^ running ? (enabled ? -1 : time) : stamp;
 
     override public action Reset(){ stamp = -1; return @void(); }

Src/Decorators/Undef.cs

@@ -14,15 +14,17 @@ public class Undef : AbstractDecorator{
 
     static int uid; internal static int id => uid = ID(uid);
     protected Random _random;
-    float stamp;
+    internal float stamp;
     status value;
 
 	public Undef(){}
 
-    protected Random random => _random ?? (_random = new Random());
+    internal Random random => _random ?? (_random = new Random());
 
     public status this[float s]{ get{
-		var t = time; if(stamp == 0) stamp = t; var remaining = s + stamp - t;
+		var t = time;
+        if(stamp == 0) stamp = t;
+        var remaining = s + stamp - t;
 		return (
             (remaining > 0) ? value
             : (value = status.@unchecked(random.Next(-1, 2)))