feat: add compare for high level graph edge

.gitignore

@@ -4,4 +4,4 @@ obj/
 bin/
 dist/
 build/
-Folder.DotSettings.user/
+Folder.DotSettings.user

Handle/BNFlowGraphNode.cs

@@ -155,8 +155,5 @@ public void SetOutgoingEdgePoints(ulong edgeNum, Point[] points)
 			    (ulong)points.Length
 		    );
 	    }
-
-
-
 	}
 }

HighLevelIL/HighLevelILBasicBlock.cs

@@ -6,7 +6,7 @@ namespace BinaryNinja
 {
 	public sealed class HighLevelILBasicBlock : AbstractBasicBlock<HighLevelILBasicBlock>
 	{
-		internal HighLevelILFunction ILFunction { get; } 
+		public HighLevelILFunction ILFunction { get; } 
 
 		internal HighLevelILBasicBlock(
 			HighLevelILFunction function ,
@@ -46,7 +46,6 @@ IntPtr handle
 				true
 			);
 		}
-
 
 		public HighLevelILInstruction this[HighLevelILInstructionIndex index]
 		{
@@ -290,7 +289,6 @@ public HighLevelILBasicBlock[] PostDominatorTreeChildren
 		    }
 	    }
 
-
 	    public HighLevelILBasicBlock[] GetDominanceFrontier(bool post)
 	    {
 		    ulong arrayLength = 0;

HighLevelIL/HighLevelILFlowGraph.cs

@@ -4,7 +4,7 @@ namespace BinaryNinja
 {
 	public sealed class HighLevelILFlowGraph : AbstractFlowGraph<HighLevelILFlowGraph>
 	{
-		internal HighLevelILFunction ILFunction { get; set; }
+		public HighLevelILFunction ILFunction { get; }
 
 		internal HighLevelILFlowGraph(
 			HighLevelILFunction ilFunction,
@@ -95,8 +95,6 @@ internal static HighLevelILFlowGraph MustBorrowHandleEx(
 			return new HighLevelILFlowGraph(ilFunction , handle, false);
 		}
 
-
-
 		public HighLevelILFlowGraph? Update()
 		{
 			return HighLevelILFlowGraph.TakeHandleEx(
@@ -130,8 +128,7 @@ out ulong arrayLength
 				NativeMethods.BNGetFlowGraphNode(this.handle, index)
 			);
 		}
-
-
+
 		public HighLevelILFlowGraphNode[] GetNodesInRegion(
 			int left  , 
 			int top  , 

HighLevelIL/HighLevelILFlowGraphEdge.cs

@@ -1,26 +1,128 @@
+using System;
+
 namespace BinaryNinja
 {
-	public sealed class HighLevelILFlowGraphEdge : AbstractFlowGraphEdge<HighLevelILFlowGraphNode>
+	public sealed class HighLevelILFlowGraphEdge 
+		: AbstractFlowGraphEdge<HighLevelILFlowGraphNode>,
+		IEquatable<HighLevelILFlowGraphEdge>, 
+		IComparable<HighLevelILFlowGraphEdge>
 	{
-		internal HighLevelILFunction ILFunction { get; set; }
-
 		internal HighLevelILFlowGraphEdge(
-			HighLevelILFunction ilFunction,
-			BNFlowGraphEdge native)
-			: base(native , HighLevelILFlowGraphNode.NewFromHandleEx(ilFunction, native.target))
+			BNFlowGraphEdge native,
+			HighLevelILFlowGraphNode source,
+			HighLevelILFlowGraphNode target,
+			bool outgoing
+		) : base(native , source, target, outgoing)
 		{
-			this.ILFunction = ilFunction;
+
 		}
 
 		internal static HighLevelILFlowGraphEdge FromNativeEx(
-			HighLevelILFunction ilFunction,
-			BNFlowGraphEdge native
+			BNFlowGraphEdge native,
+			HighLevelILFlowGraphNode me,
+			bool outgoing
 		)
 		{
-			return new HighLevelILFlowGraphEdge(
-				ilFunction ,
-				native
+			if (outgoing)
+			{
+				return new HighLevelILFlowGraphEdge(
+					native,
+					me , 
+					HighLevelILFlowGraphNode.MustNewFromHandleEx(me.ILFunction, native.target),
+					outgoing
+				);
+			}
+			else
+			{
+				return new HighLevelILFlowGraphEdge(
+					native,
+					HighLevelILFlowGraphNode.MustNewFromHandleEx(me.ILFunction,native.target) , 
+					me,
+					outgoing
+				);
+			}
+		}
+
+		public override bool Equals(object? other)
+		{
+			return this.Equals(other as HighLevelILFlowGraphEdge);
+		}
+
+		public bool Equals(HighLevelILFlowGraphEdge? other)
+		{
+			if (other is null)
+			{
+				return false;
+			}
+
+			if (ReferenceEquals(this , other))
+			{
+				return true;
+			}
+
+			if (this.Type != other.Type)
+			{
+				return false;
+			}
+
+			if (this.Source != other.Source)
+			{
+				return false;
+			}
+
+			if (this.Target != other.Target)
+			{
+				return false;
+			}
+
+			return true;
+		}
+
+		[System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2218:OverrideGetHashCodeOnOverridingEquals")]
+		public override int GetHashCode()
+		{
+			return HashCode.Combine<uint,int,int>( 
+				(uint)this.Type,
+				this.Source.GetHashCode(),
+				this.Target.GetHashCode()
 			);
 		}
+
+		public static bool operator ==(HighLevelILFlowGraphEdge? left, HighLevelILFlowGraphEdge? right)
+		{
+			if (left is null)
+			{
+				return right is null;
+			}
+
+			return left.Equals(right);
+		}
+
+		public static bool operator !=(HighLevelILFlowGraphEdge? left, HighLevelILFlowGraphEdge? right)
+		{
+			return !(left == right);
+		}
+
+		public int CompareTo(HighLevelILFlowGraphEdge? other)
+		{
+			if (other is null)
+			{
+				return 1;
+			}
+
+			int result = this.Type.CompareTo(other.Type);
+
+			if (0 == result)
+			{
+				result = this.Source.CompareTo(other.Source);
+			}
+
+			if (0 == result)
+			{
+				result = this.Target.CompareTo(other.Target);
+			}
+
+			return result;
+		}
 	}
 }

HighLevelIL/HighLevelILFlowGraphNode.cs

@@ -4,7 +4,7 @@ namespace BinaryNinja
 {
 	public sealed class HighLevelILFlowGraphNode : FlowGraphNode
 	{
-		internal HighLevelILFunction ILFunction { get; set; }
+		public HighLevelILFunction ILFunction { get; }
 
 		internal HighLevelILFlowGraphNode(
 			HighLevelILFunction  ilFunction,
@@ -107,7 +107,6 @@ internal static HighLevelILFlowGraphNode MustBorrowHandleEx(
 				false);
 		}
 
-
 		public HighLevelILBasicBlock? BasicBlock
 		{
 			get
@@ -131,17 +130,19 @@ public HighLevelILFlowGraphEdge[] IncomingEdges
 		{
 			get
 			{
-				ulong arrayLength = 0;
-
 				IntPtr arrayPointer = NativeMethods.BNGetFlowGraphNodeIncomingEdges(
 					this.handle,
-					out arrayLength 
+					out ulong arrayLength 
 				);
 
 				return UnsafeUtils.TakeStructArrayEx<BNFlowGraphEdge,HighLevelILFlowGraphEdge>(
 					arrayPointer,
 					arrayLength,
-					(_native) => HighLevelILFlowGraphEdge.FromNativeEx(this.ILFunction, _native),
+					(_native) => HighLevelILFlowGraphEdge.FromNativeEx(
+						_native,
+						this,
+						false
+					),
 					NativeMethods.BNFreeFlowGraphNodeEdgeList
 				);
 			}
@@ -151,17 +152,19 @@ public HighLevelILFlowGraphEdge[] OutgoingEdges
 		{
 			get
 			{
-				ulong arrayLength = 0;
-
 				IntPtr arrayPointer = NativeMethods.BNGetFlowGraphNodeOutgoingEdges(
 					this.handle,
-					out arrayLength 
+					out ulong arrayLength 
 				);
 
 				return UnsafeUtils.TakeStructArrayEx<BNFlowGraphEdge,HighLevelILFlowGraphEdge>(
 					arrayPointer,
 					arrayLength,
-					(_native) => HighLevelILFlowGraphEdge.FromNativeEx(this.ILFunction, _native),
+					(_native) => HighLevelILFlowGraphEdge.FromNativeEx(
+						_native,
+						this,
+						true
+					),
 					NativeMethods.BNFreeFlowGraphNodeEdgeList
 				);
 			}

LowLevelIL/LowLevelILFlowGraphEdge.cs

@@ -3,22 +3,39 @@ namespace BinaryNinja
 	public sealed class LowLevelILFlowGraphEdge : AbstractFlowGraphEdge<LowLevelILFlowGraphNode>
 	{
 		public LowLevelILFlowGraphEdge(
-			LowLevelILFunction ilFunction,
-			BNFlowGraphEdge native)
-			: base(native , LowLevelILFlowGraphNode.NewFromHandleEx(ilFunction, native.target))
+			BNFlowGraphEdge native,
+			LowLevelILFlowGraphNode source,
+			LowLevelILFlowGraphNode target,
+			bool outgoing
+		) : base(native , source, target, outgoing)
 		{
 
 		}
 
 		internal static LowLevelILFlowGraphEdge FromNativeEx(
-			LowLevelILFunction ilFunction,
-			BNFlowGraphEdge native
+			BNFlowGraphEdge native,
+			LowLevelILFlowGraphNode me,
+			bool outgoing
 		)
 		{
-			return new LowLevelILFlowGraphEdge(
-				ilFunction ,
-				native
-			);
+			if (outgoing)
+			{
+				return new LowLevelILFlowGraphEdge(
+					native,
+					me , 
+					LowLevelILFlowGraphNode.MustNewFromHandleEx(me.ILFunction, native.target),
+					outgoing
+				);
+			}
+			else
+			{
+				return new LowLevelILFlowGraphEdge(
+					native,
+					LowLevelILFlowGraphNode.MustNewFromHandleEx(me.ILFunction,native.target) , 
+					me,
+					outgoing
+				);
+			}
 		}
 	}
 }

LowLevelIL/LowLevelILFlowGraphNode.cs

@@ -131,17 +131,19 @@ public LowLevelILFlowGraphEdge[] IncomingEdges
 		{
 			get
 			{
-				ulong arrayLength = 0;
-
 				IntPtr arrayPointer = NativeMethods.BNGetFlowGraphNodeIncomingEdges(
 					this.handle,
-					out arrayLength 
+					out ulong arrayLength 
 				);
 
 				return UnsafeUtils.TakeStructArrayEx<BNFlowGraphEdge,LowLevelILFlowGraphEdge>(
 					arrayPointer,
 					arrayLength,
-					(_native) => LowLevelILFlowGraphEdge.FromNativeEx(this.ILFunction, _native),
+					(_native) => LowLevelILFlowGraphEdge.FromNativeEx(
+						_native,
+						this,
+						false
+					),
 					NativeMethods.BNFreeFlowGraphNodeEdgeList
 				);
 			}
@@ -151,17 +153,19 @@ public LowLevelILFlowGraphEdge[] OutgoingEdges
 		{
 			get
 			{
-				ulong arrayLength = 0;
-
 				IntPtr arrayPointer = NativeMethods.BNGetFlowGraphNodeOutgoingEdges(
 					this.handle,
-					out arrayLength 
+					out ulong arrayLength 
 				);
 
 				return UnsafeUtils.TakeStructArrayEx<BNFlowGraphEdge,LowLevelILFlowGraphEdge>(
 					arrayPointer,
 					arrayLength,
-					(_native) => LowLevelILFlowGraphEdge.FromNativeEx(this.ILFunction, _native),
+					(_native) => LowLevelILFlowGraphEdge.FromNativeEx(
+						_native,
+						this,
+						true
+					),
 					NativeMethods.BNFreeFlowGraphNodeEdgeList
 				);
 			}