handle paths as fixed size arrays

Author: MattFiler

CathodeLib/Scripts/CATHODE/Commands.cs

@@ -189,7 +189,7 @@ override protected bool LoadInternal()
                                             reader_parallel.BaseStream.Position = (offsetPairs[x].GlobalOffset * 4) + (y * 12);
                                             AliasEntity overrider = new AliasEntity(new ShortGuid(reader_parallel));
                                             int NumberOfParams = JumpToOffset(reader_parallel);
-                                            overrider.alias.path.AddRange(Utilities.ConsumeArray<ShortGuid>(reader_parallel, NumberOfParams));
+                                            overrider.alias.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, NumberOfParams);
                                             composite.aliases.Add(overrider);
                                             break;
                                         }
@@ -214,7 +214,7 @@ override protected bool LoadInternal()
                                             ProxyEntity thisProxy = new ProxyEntity(new ShortGuid(reader_parallel));
                                             int resetPos = (int)reader_parallel.BaseStream.Position + 8; //TODO: This is a HACK - I need to rework JumpToOffset to make a temp stream
                                             int NumberOfParams = JumpToOffset(reader_parallel);
-                                            thisProxy.proxy.path.AddRange(Utilities.ConsumeArray<ShortGuid>(reader_parallel, NumberOfParams)); //Last is always 0x00, 0x00, 0x00, 0x00
+                                            thisProxy.proxy.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, NumberOfParams); //Last is always 0x00, 0x00, 0x00, 0x00
                                             reader_parallel.BaseStream.Position = resetPos;
                                             ShortGuid idCheck = new ShortGuid(reader_parallel);
                                             if (idCheck != thisProxy.shortGUID) throw new Exception("Proxy ID mismatch!");
@@ -315,7 +315,7 @@ override protected bool LoadInternal()
                                                 header.parameterSubID = new ShortGuid(reader_parallel);
 
                                                 int hierarchyCount = JumpToOffset(reader_parallel);
-                                                header.connectedEntity.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, hierarchyCount).ToList<ShortGuid>();
+                                                header.connectedEntity.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, hierarchyCount);
                                                 animEntity.connections.Add(header);
                                             }
 
@@ -397,7 +397,7 @@ override protected bool LoadInternal()
                                                 TriggerSequence.Entity thisTrigger = new TriggerSequence.Entity();
                                                 thisTrigger.timing = reader_parallel.ReadSingle();
                                                 reader_parallel.BaseStream.Position = hierarchyOffset;
-                                                thisTrigger.connectedEntity.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, hierarchyCount).ToList<ShortGuid>();
+                                                thisTrigger.connectedEntity.path = Utilities.ConsumeArray<ShortGuid>(reader_parallel, hierarchyCount);
                                                 trigEntity.entities.Add(thisTrigger);
                                             }
 
@@ -849,7 +849,7 @@ override protected bool SaveInternal()
                                     List<OffsetPair> offsetPairs = new List<OffsetPair>(reshuffledAliases[i].Count);
                                     for (int p = 0; p < reshuffledAliases[i].Count; p++)
                                     {
-                                        offsetPairs.Add(new OffsetPair(writer.BaseStream.Position, reshuffledAliases[i][p].alias.path.Count));
+                                        offsetPairs.Add(new OffsetPair(writer.BaseStream.Position, reshuffledAliases[i][p].alias.path.Length));
                                         Utilities.Write<ShortGuid>(writer, reshuffledAliases[i][p].alias.path);
                                     }
 
@@ -888,7 +888,7 @@ override protected bool SaveInternal()
                                     List<OffsetPair> offsetPairs = new List<OffsetPair>();
                                     for (int p = 0; p < Entries[i].proxies.Count; p++)
                                     {
-                                        offsetPairs.Add(new OffsetPair(writer.BaseStream.Position, Entries[i].proxies[p].proxy.path.Count));
+                                        offsetPairs.Add(new OffsetPair(writer.BaseStream.Position, Entries[i].proxies[p].proxy.path.Length));
                                         Utilities.Write<ShortGuid>(writer, Entries[i].proxies[p].proxy.path);
                                     }
 
@@ -983,7 +983,7 @@ override protected bool SaveInternal()
                                             Utilities.Write(writer, CommandsUtils.GetDataTypeGUID(header.parameterDataType));
                                             Utilities.Write(writer, header.parameterSubID);
                                             writer.Write(hierarchyOffsets[pp] / 4);
-                                            writer.Write(header.connectedEntity.path.Count);
+                                            writer.Write(header.connectedEntity.path.Length);
                                         }
 
                                         List<int> internalOffsets = new List<int>(cageAnimationEntities[i][p].animations.Count);
@@ -1094,7 +1094,7 @@ override protected bool SaveInternal()
                                         for (int pp = 0; pp < triggerSequenceEntities[i][p].entities.Count; pp++)
                                         {
                                             writer.Write(hierarchyOffsets[pp] / 4);
-                                            writer.Write(triggerSequenceEntities[i][p].entities[pp].connectedEntity.path.Count);
+                                            writer.Write(triggerSequenceEntities[i][p].entities[pp].connectedEntity.path.Length);
                                             writer.Write(triggerSequenceEntities[i][p].entities[pp].timing);
                                         }
 

CathodeLib/Scripts/CATHODE/CommandsPAK/Components/Composite.cs

@@ -105,10 +105,10 @@ public VariableEntity AddVariable(string parameter, DataType type, bool addDefau
         }
 
         /* Add a new proxy entity */
-        public ProxyEntity AddProxy(Commands commands, List<ShortGuid> hierarchy, bool addDefaultParam = false)
+        public ProxyEntity AddProxy(Commands commands, ShortGuid[] hierarchy, bool addDefaultParam = false)
         {
             CommandsUtils.ResolveHierarchy(commands, this, hierarchy, out Composite targetComposite, out string str);
-            Entity ent = targetComposite.GetEntityByID(hierarchy[hierarchy.Count - 2]);
+            Entity ent = targetComposite.GetEntityByID(hierarchy[hierarchy.Length - 2]);
             if (ent.variant != EntityVariant.FUNCTION) return null;
 
             ProxyEntity proxy = new ProxyEntity(hierarchy, ((FunctionEntity)ent).function, addDefaultParam);
@@ -117,7 +117,7 @@ public ProxyEntity AddProxy(Commands commands, List<ShortGuid> hierarchy, bool a
         }
 
         /* Add a new alias entity */
-        public AliasEntity AddAlias(List<ShortGuid> hierarchy)
+        public AliasEntity AddAlias(ShortGuid[] hierarchy)
         {
             AliasEntity alias = new AliasEntity(hierarchy);
             aliases.Add(alias);

CathodeLib/Scripts/CATHODE/CommandsPAK/Components/Entity.cs

@@ -466,13 +466,13 @@ public class ProxyEntity : Entity
         public ProxyEntity() : base(EntityVariant.PROXY) { }
         public ProxyEntity(ShortGuid shortGUID) : base(shortGUID, EntityVariant.PROXY) { }
 
-        public ProxyEntity(List<ShortGuid> hierarchy = null, ShortGuid targetType = new ShortGuid(), bool autoGenerateParameters = false) : base(EntityVariant.PROXY)
+        public ProxyEntity(ShortGuid[] hierarchy = null, ShortGuid targetType = new ShortGuid(), bool autoGenerateParameters = false) : base(EntityVariant.PROXY)
         {
             this.function = targetType;
             if (hierarchy != null) this.proxy.path = hierarchy;
             if (autoGenerateParameters) EntityUtils.ApplyDefaults(this);
         }
-        public ProxyEntity(ShortGuid shortGUID, List<ShortGuid> hierarchy = null, ShortGuid targetType = new ShortGuid(), bool autoGenerateParameters = false) : base(shortGUID, EntityVariant.PROXY)
+        public ProxyEntity(ShortGuid shortGUID, ShortGuid[] hierarchy = null, ShortGuid targetType = new ShortGuid(), bool autoGenerateParameters = false) : base(shortGUID, EntityVariant.PROXY)
         {
             this.shortGUID = shortGUID;
             this.function = targetType; 
@@ -489,11 +489,11 @@ public class AliasEntity : Entity
         public AliasEntity() : base(EntityVariant.ALIAS) { }
         public AliasEntity(ShortGuid shortGUID) : base(shortGUID, EntityVariant.ALIAS) { }
 
-        public AliasEntity(List<ShortGuid> hierarchy = null) : base(EntityVariant.ALIAS)
+        public AliasEntity(ShortGuid[] hierarchy = null) : base(EntityVariant.ALIAS)
         {
             if (hierarchy != null) this.alias.path = hierarchy;
         }
-        public AliasEntity(ShortGuid shortGUID, List<ShortGuid> hierarchy = null) : base(shortGUID, EntityVariant.ALIAS)
+        public AliasEntity(ShortGuid shortGUID, ShortGuid[] hierarchy = null) : base(shortGUID, EntityVariant.ALIAS)
         {
             this.shortGUID = shortGUID;
             if (hierarchy != null) this.alias.path = hierarchy;
@@ -678,21 +678,19 @@ public override int GetHashCode()
     public class EntityPath
     {
         public EntityPath() { }
-        public EntityPath(List<ShortGuid> _path)
+        public EntityPath(ShortGuid[] _path)
         {
-            path = _path;
-
-            if (path.Count == 0 || path[path.Count - 1] != ShortGuid.Invalid)
-                path.Add(ShortGuid.Invalid);
+            path = (ShortGuid[])_path.Clone();
+            EnsureFinalIsEmpty();
         }
-        public List<ShortGuid> path = new List<ShortGuid>();
+        public ShortGuid[] path = new ShortGuid[0];
 
         public static bool operator ==(EntityPath x, EntityPath y)
         {
             if (ReferenceEquals(x, null)) return ReferenceEquals(y, null);
             if (ReferenceEquals(y, null)) return ReferenceEquals(x, null);
-            if (x.path.Count != y.path.Count) return false;
-            for (int i = 0; i < x.path.Count; i++)
+            if (x.path.Length != y.path.Length) return false;
+            for (int i = 0; i < x.path.Length; i++)
             {
                 if (x.path[i].ToByteString() != y.path[i].ToByteString())
                     return false;
@@ -706,23 +704,32 @@ public EntityPath(List<ShortGuid> _path)
 
         public override bool Equals(object obj)
         {
-            return obj is EntityPath hierarchy &&
-                   EqualityComparer<List<ShortGuid>>.Default.Equals(this.path, hierarchy.path);
+            return obj is EntityPath path &&
+                   EqualityComparer<ShortGuid[]>.Default.Equals(this.path, path.path);
         }
 
         public override int GetHashCode()
         {
-            return 218564712 + EqualityComparer<List<ShortGuid>>.Default.GetHashCode(path);
+            return -1757656154 + EqualityComparer<ShortGuid[]>.Default.GetHashCode(path);
+        }
+
+        private void EnsureFinalIsEmpty()
+        {
+            if (path.Length == 0 || path[path.Length - 1] != ShortGuid.Invalid)
+            {
+                Array.Resize(ref path, path.Length + 1);
+                path[path.Length - 1] = ShortGuid.Invalid;
+            }
         }
 
         /* Get this path as a string */
         public string GetAsString()
         {
             string val = "";
-            for (int i = 0; i < path.Count; i++)
+            for (int i = 0; i < path.Length; i++)
             {
                 val += path[i].ToByteString();
-                if (i != path.Count - 1) val += " -> ";
+                if (i != path.Length - 1) val += " -> ";
             }
             return val;
         }
@@ -735,7 +742,7 @@ public string GetAsString(Commands commands, Composite composite, bool withIDs =
         public UInt32 ToUInt32()
         {
             UInt32 val = 0;
-            for (int i = 0; i < path.Count; i++) val += path[i].ToUInt32();
+            for (int i = 0; i < path.Length; i++) val += path[i].ToUInt32();
             return val;
         }
 
@@ -771,7 +778,7 @@ public Entity GetPointedEntity(Commands commands, Composite startComposite, out
         public ShortGuid GetPointedEntityID()
         {
             ShortGuid id = ShortGuid.Invalid;
-            for (int i = path.Count - 1; i >= 0; i--)
+            for (int i = path.Length - 1; i >= 0; i--)
             {
                 if (path[i] == ShortGuid.Invalid) continue;
                 id = path[i];
@@ -789,15 +796,16 @@ public bool IsPathValid(Commands commands, Composite composite)
         /* Generate the checksum used identify the path */
         public ShortGuid GeneratePathHash()
         {
-            if (path.Count == 0) return ShortGuid.Invalid;
-            if (path[path.Count - 1] != ShortGuid.Invalid) path.Add(ShortGuid.Invalid);
+            if (path.Length == 0) return ShortGuid.Invalid;
+            EnsureFinalIsEmpty();
 
+            //TODO: invert loop rather than array
             path.Reverse();
             ShortGuid checksumGenerated = path[0];
-            for (int i = 0; i < path.Count; i++)
+            for (int i = 0; i < path.Length; i++)
             {
                 checksumGenerated = checksumGenerated.Combine(path[i + 1]);
-                if (i == path.Count - 2) break;
+                if (i == path.Length - 2) break;
             }
             path.Reverse();
 
@@ -815,19 +823,78 @@ public ShortGuid GenerateZoneID()
         {
             return new ShortGuid(0 + GenerateCompositeInstanceID().ToUInt32() + GetPointedEntityID().ToUInt32() + 1);
         }
-        
-        /* Updates this path to have the path to another entity prepended to it */
-        public void PrependPath(EntityPath otherPath)
+
+        /* Add the next entity GUID along the path */
+        public void AddNextStep(Entity entity)
         {
-            int length = otherPath.path[otherPath.path.Count - 1] == ShortGuid.Invalid ? otherPath.path.Count - 2 : otherPath.path.Count - 1;
-            for (int i = 0; i < length; i++)
-                path.Insert(i, otherPath.path[i]);
+            AddNextStep(entity.shortGUID);
+        }
+        public void AddNextStep(ShortGuid guid)
+        {
+            if (path.Length > 0 && path[path.Length - 1] == ShortGuid.Invalid)
+            {
+                path[path.Length - 1] = guid;
+            }
+            else
+            {
+                Array.Resize(ref path, path.Length + 1);
+                path[path.Length - 1] = guid;
+            }
+            EnsureFinalIsEmpty();
+        }
+
+        /* Remove the last entity GUID along the path */
+        public void GoBackOneStep()
+        {
+            if (path.Length > 0 && path[path.Length - 1] == ShortGuid.Invalid)
+            {
+                if (path.Length > 1)
+                {
+                    path[path.Length - 2] = ShortGuid.Invalid;
+                    Array.Resize(ref path, path.Length - 1);
+                }
+            }
+            else if (path.Length > 0)
+            {
+                path[path.Length - 1] = ShortGuid.Invalid;
+            }
+            else
+            {
+                EnsureFinalIsEmpty();
+            }
         }
+        
+        /* Updates this path to have the path to another entity prepended to it */
+        //public void PrependPath(EntityPath otherPath)
+        //{
+        //    int length = otherPath.path[otherPath.path.Count - 1] == ShortGuid.Invalid ? otherPath.path.Count - 2 : otherPath.path.Count - 1;
+        //    for (int i = 0; i < length; i++)
+        //        path.Insert(i, otherPath.path[i]);
+        //}
     }
 
     public static class PathUtils
     {
         /* Generate the instance ID used to identify the instanced composite we're executed in */
+        public static ShortGuid GenerateCompositeInstanceID(this ShortGuid[] path, bool hasInternalEntityID = true) //Set this to false the final value in the path is not an entity ID within the composite
+        {
+            bool hasTrailingInvalid = (path.Length > 0 && path[path.Length - 1] == ShortGuid.Invalid);
+            ShortGuid[] values = new ShortGuid[hasInternalEntityID ? (hasTrailingInvalid ? path.Length - 1 : path.Length) : (hasTrailingInvalid ? path.Length : path.Length + 1)];
+            values[values.Length - 1] = ShortGuid.InitialiserBase;
+            int x = 0;
+            for (int i = values.Length - 2; i >= 0; i--)
+            {
+                values[i] = path[x];
+                x++;
+            }
+            ShortGuid instanceGenerated = values[0];
+            for (int i = 0; i < values.Length; i++)
+            {
+                if (i == values.Length - 1) break;
+                instanceGenerated = values[i + 1].Combine(instanceGenerated);
+            }
+            return instanceGenerated;
+        }
         public static ShortGuid GenerateCompositeInstanceID(this List<ShortGuid> path, bool hasInternalEntityID = true) //Set this to false the final value in the path is not an entity ID within the composite
         {
             bool hasTrailingInvalid = (path.Count > 0 && path[path.Count - 1] == ShortGuid.Invalid);
@@ -861,7 +928,8 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
         {
             EntityPath e = new EntityPath();
             List<string> vals = reader.Value.ToString().Split(new[] { " -> " }, StringSplitOptions.None).ToList();
-            for (int i = 0; i < vals.Count; i++) e.path.Add(new ShortGuid(vals[i]));
+            e.path = new ShortGuid[vals.Count];
+            for (int i = 0; i < vals.Count; i++) e.path[i] = new ShortGuid(vals[i]);
             return e;
         }