[WIP] in the middle of refactor on correct handling of collection. The CollectionCursor class has to be used all over to not loose collection context position

Author: antoineatstariongroup

SysML2.NET.CodeGenerator/Grammar/Model/Alternatives.cs

@@ -21,6 +21,7 @@
 namespace SysML2.NET.CodeGenerator.Grammar.Model
 {
     using System.Collections.Generic;
+    using System.Linq;
 
     /// <summary>
     /// Provides mapping data class for the alternative grammar part
@@ -36,5 +37,23 @@ public class Alternatives: IPartOfTextualRule
         /// Gets the <see cref="IPartOfTextualRule.TextualNotationRule" />
         /// </summary>
         public TextualNotationRule TextualNotationRule { get; init; }
+
+        /// <summary>
+        /// Asserts that the current <see cref="Alternatives"/> contains <see cref="AssignmentElement"/> that are part of a collection iteration that could be called from
+        /// another rule
+        /// </summary>
+        /// <returns>The computation of the assertion</returns>
+        internal bool ContainsAssignmentRequiringDispatch()
+        {
+            var assignments = this.Elements.OfType<AssignmentElement>().Where(x => x.Operator == "+=").ToList();
+            var groupElements = this.Elements.OfType<GroupElement>().Where(x => x.IsCollection).ToList();
+
+            if (assignments.Count == 0)
+            {
+                return false;
+            }
+
+            return groupElements.Count == 0;
+        }
     }
 }

SysML2.NET.CodeGenerator/Grammar/Model/AssignmentElement.cs

@@ -43,6 +43,6 @@ public class AssignmentElement: RuleElement
         /// <summary>
         /// Gets or sets an optional prefix
         /// </summary>
-        public string Prefix { get; set; } 
+        public string Prefix { get; set; }
     }
 }

SysML2.NET.CodeGenerator/Grammar/Model/TextualNotationRule.cs

@@ -21,6 +21,7 @@
 namespace SysML2.NET.CodeGenerator.Grammar.Model
 {
     using System.Collections.Generic;
+    using System.Linq;
 
     /// <summary>
     /// Describe the content of a rule 
@@ -51,5 +52,74 @@ public class TextualNotationRule
         /// Gets or the collection of <see cref="Alternatives"/> defined by the rule
         /// </summary>
         public List<Alternatives> Alternatives { get; } = [];
+        
+        /// <summary>
+        /// Asserts that the current Rule acts has a dispatcher or not. A dispatcher needs to have index access to access element into a collection.
+        /// </summary>
+        public bool IsDispatcherRule => this.ComputeIsDispatcherRule();
+
+        /// <summary>
+        /// Asserts that the rule described assignment of multiple collection
+        /// </summary>
+        public bool IsMultiCollectionAssignment => this.ComputeIsMultiCollectionAssigment();
+
+        /// <summary>
+        /// Gets names of property that a multicollection assignment defines
+        /// </summary>
+        /// <returns>The collection of property names</returns>
+        public IReadOnlyCollection<string> QueryMultiCollectionPropertiesName()
+        {
+            if (!this.IsMultiCollectionAssignment)
+            {
+                return Enumerable.Empty<string>().ToList();
+            }
+            
+            var assignments = this.Alternatives.SelectMany(x => x.Elements).OfType<AssignmentElement>();
+            return assignments.Where(x => x.Operator == "+=").DistinctBy(x => x.Property).Select(x => x.Property).ToList();
+        }
+
+        /// <summary>
+        /// Computes the value of the <see cref="IsMultiCollectionAssignment"/> 
+        /// </summary>
+        /// <returns>The result of the assertion computation</returns>
+        private bool ComputeIsMultiCollectionAssigment()
+        {
+            if (this.Alternatives.Count == 1)
+            {
+                return false;
+            }
+
+            var assignments = this.Alternatives.SelectMany(x => x.Elements).OfType<AssignmentElement>();
+            return assignments.Where(x => x.Operator == "+=").DistinctBy(x => x.Property).Count() > 1;
+        }
+
+        /// <summary>
+        /// Computes the assertion that the <see cref="TextualNotationRule"/> is a dispatcher or not
+        /// </summary>
+        /// <returns>The result of the assertion computation</returns>
+        private bool ComputeIsDispatcherRule()
+        {
+            return this.Alternatives.Count > 1 && this.Alternatives.Any(x => x.Elements.OfType<AssignmentElement>().Any(a => a.Operator == "+="))
+                   || this.Alternatives.Count == 1 && this.Alternatives[0].Elements.Count == 1 && this.Alternatives[0].Elements[0] is AssignmentElement { Operator: "+="};
+        }
+
+        /// <summary>
+        /// Gets the <see cref="AssignmentElement"/> that requires a dispatcher 
+        /// </summary>
+        /// <returns>The <see cref="AssignmentElement"/></returns>
+        public AssignmentElement GetAssignmentElementNeedingDispatcher()
+        {
+            if (!this.IsDispatcherRule)
+            {
+                return null;
+            }
+
+            if (this.Alternatives.Count == 1)
+            {
+                return this.Alternatives[0].Elements[0] as AssignmentElement;
+            }
+
+            return this.Alternatives.SelectMany(x => x.Elements).OfType<AssignmentElement>().FirstOrDefault(x => x.Operator == "+=");
+        }
     }
 }

SysML2.NET.CodeGenerator/HandleBarHelpers/PropertyHelper.cs

@@ -300,7 +300,7 @@ public static void RegisterPropertyHelper(this IHandlebars handlebars)
                 {
                     if (property.QueryPropertyIsPartOfNonDerivedCompositeAggregation())
                     {
-                        sb.Append($"IReadOnlyCollection<{typeName}> ");
+                        sb.Append($"IReadOnlyList<{typeName}> ");
                     }
                     else
                     {
@@ -378,7 +378,7 @@ public static void RegisterPropertyHelper(this IHandlebars handlebars)
                 {
                     if (property.QueryPropertyIsPartOfNonDerivedCompositeAggregation())
                     {
-                        sb.Append($"IReadOnlyCollection<{typeName}> ");
+                        sb.Append($"IReadOnlyList<{typeName}> ");
                     }
                     else
                     {