Junction restrictions hook

TLM/TLM/Manager/Impl/JunctionRestrictionsManager.cs

@@ -17,6 +17,7 @@ namespace TrafficManager.Manager.Impl {
     using TrafficManager.Util;
     using TrafficManager.Util.Extensions;
     using TrafficManager.Lifecycle;
+    using TrafficManager.API.Traffic.Enums;
 
     public class JunctionRestrictionsManager
         : AbstractGeometryObservingManager,
@@ -38,6 +39,8 @@ private JunctionRestrictionsManager() {
             invalidSegmentRestrictions = new SegmentJunctionRestrictions[NetManager.MAX_SEGMENT_COUNT];
         }
 
+        public event Action<IJunctionRestrictionsManager.FlagsChangedEventArgs> FlagsChanged;
+
         private void AddInvalidSegmentJunctionRestrictions(ushort segmentId,
                                                            bool startNode,
                                                            ref JunctionRestrictions restrictions) {
@@ -1318,15 +1321,6 @@ public bool LoadData(List<Configuration.SegmentNodeConf> data) {
             return ret;
         }
 
-        private enum JunctionRestrictionFlags {
-            AllowUTurn = 1 << 0,
-            AllowNearTurnOnRed = 1 << 1,
-            AllowFarTurnOnRed = 1 << 2,
-            AllowForwardLaneChange = 1 << 3,
-            AllowEnterWhenBlocked = 1 << 4,
-            AllowPedestrianCrossing = 1 << 5,
-        }
-
         private struct SegmentJunctionRestrictions {
             public JunctionRestrictions startNodeRestrictions;
             public JunctionRestrictions endNodeRestrictions;

TLM/TMPE.API/Hook/IJunctionRestrictionsHook.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using TrafficManager.API.Traffic.Enums;
+
+namespace TrafficManager.API.Hook {
+    public interface IJunctionRestrictionsHook {
+
+        /// <summary>
+        /// An event that allows a handler to modify the results of a <c>GetDefault<i>TrafficRule</i></c> method.
+        /// </summary>
+        event Action<FlagsHookArgs> GetDefaults;
+
+        /// <summary>
+        /// An event that allows a handler to modify the results of an <c>Is<i>TrafficRule</i>Configurable</c> method.
+        /// </summary>
+        event Action<FlagsHookArgs> GetConfigurable;
+
+        /// <summary>
+        /// Invalidates the specified flags so that they will be recalculated.
+        /// Recalculation is not guaranteed to happen immediately, but is guaranteed to happen
+        /// before their next use.
+        /// </summary>
+        /// <param name="flags"></param>
+        public void InvalidateFlags(JunctionRestrictionFlags flags);
+
+        public class FlagsHookArgs {
+
+            /// <summary>
+            /// Identifies the segment for which flag data is being returned.
+            /// </summary>
+            public ushort SegmentId { get; private set; }
+
+            /// <summary>
+            /// Identifies the node on the segment for which flag data is being returned.
+            /// </summary>
+            public bool StartNode { get; private set; }
+
+            /// <summary>
+            /// Identifies which flags are being returned. Unnecessary computation may be avoided
+            /// by examining this mask to see which flags are being requested.
+            /// </summary>
+            public JunctionRestrictionFlags Mask { get; private set; }
+
+            /// <summary>
+            /// The flag return values. Changes to this property alter the outcome of the underlying operation.
+            /// </summary>
+            public JunctionRestrictionFlags Result { get; set; }
+
+            internal FlagsHookArgs(ushort segmentId, bool startNode, JunctionRestrictionFlags mask, JunctionRestrictionFlags result) {
+                SegmentId = segmentId;
+                StartNode = startNode;
+                Mask = mask;
+                Result = result;
+            }
+        }
+    }
+}

TLM/TMPE.API/Manager/IJunctionRestrictionsManager.cs

@@ -1,5 +1,7 @@
 namespace TrafficManager.API.Manager {
     using CSUtil.Commons;
+    using System;
+    using TrafficManager.API.Traffic.Enums;
 
     public interface IJunctionRestrictionsManager {
         #region Is<Traffic Rule>Configurable
@@ -574,5 +576,17 @@ bool GetDefaultPedestrianCrossingAllowed(ushort segmentId,
         /// Updates the default values for all junction restrictions and segments.
         /// </summary>
         void UpdateAllDefaults();
+
+        event Action<FlagsChangedEventArgs> FlagsChanged;
+
+        public class FlagsChangedEventArgs {
+
+            public JunctionRestrictionFlags Flags { get; private set; }
+
+            public FlagsChangedEventArgs(JunctionRestrictionFlags flags) {
+                Flags = flags;
+            }
+        }
+
     }
 }

TLM/TMPE.API/TMPE.API.csproj

@@ -76,6 +76,7 @@
       <Link>Properties\SharedAssemblyInfo.cs</Link>
     </Compile>
     <Compile Include="Harmony.cs" />
+    <Compile Include="Hook\IJunctionRestrictionsHook.cs" />
     <Compile Include="Implementations.cs" />
     <Compile Include="Geometry\SegmentEndReplacement.cs" />
     <Compile Include="Manager\IAdvancedParkingManager.cs" />
@@ -144,6 +145,7 @@
     <Compile Include="Traffic\Enums\ExtVehicleType.cs" />
     <Compile Include="Traffic\Enums\FlowWaitCalcMode.cs" />
     <Compile Include="Traffic\Enums\GeometryCalculationMode.cs" />
+    <Compile Include="Traffic\Enums\JunctionRestrictionFlags.cs" />
     <Compile Include="Traffic\Enums\LocaleKeyAttribute.cs" />
     <Compile Include="Traffic\Enums\LaneArrows.cs" />
     <Compile Include="Traffic\Enums\LaneEndTransitionGroup.cs" />

TLM/TMPE.API/Traffic/Enums/JunctionRestrictionFlags.cs

@@ -0,0 +1,10 @@
+namespace TrafficManager.API.Traffic.Enums {
+    public enum JunctionRestrictionFlags {
+        AllowUTurn = 1 << 0,
+        AllowNearTurnOnRed = 1 << 1,
+        AllowFarTurnOnRed = 1 << 2,
+        AllowForwardLaneChange = 1 << 3,
+        AllowEnterWhenBlocked = 1 << 4,
+        AllowPedestrianCrossing = 1 << 5,
+    }
+}