Clean up CalligraphySerializer

Author: Crypto137

src/MHServerEmu/Games/GameData/Calligraphy/CalligraphySerializer.FieldCopying.cs

@@ -133,11 +133,5 @@ private static void CopyPrototypePropertyCollection()
         {
             // NYI
         }
-
-        private static bool IsMixin(Type type)
-        {
-            return type == typeof(LocomotorPrototype) || type == typeof(PopulationInfoPrototype) || type == typeof(ProductPrototype);
-        }
-
     }
 }

src/MHServerEmu/Games/GameData/Calligraphy/CalligraphySerializer.Parsing.cs

@@ -111,8 +111,7 @@ private static bool ParseEnum(FieldParserParams @params)
         /// </summary>
         private static bool ParseDataRef(FieldParserParams @params)
         {
-            // Data refs can be StringId, AssetTypeId, CurveId, PrototypeId, LocaleStringId or ulong.
-            // Eventually we will assign appropriate data ref types to all ulong fields.
+            // Data refs can be StringId, AssetTypeId, CurveId, PrototypeId, or LocaleStringId.
             // C# enums are not picky when assigning values with reflection, so we can reuse the same code for all of them.
             var value = @params.Reader.ReadUInt64();
             @params.FieldInfo.SetValue(@params.OwnerPrototype, value);

src/MHServerEmu/Games/GameData/Calligraphy/CalligraphySerializer.cs

@@ -31,8 +31,6 @@ public override void Deserialize(Prototype prototype, PrototypeId dataRef, Strea
 
                 // Begin deserialization
                 DoDeserialize(prototype, prototypeHeader, dataRef, prototypeName, reader);
-
-                //Logger.Debug("Done!");
             }
         }
 
@@ -132,7 +130,7 @@ private static bool DeserializeFieldGroup(Prototype prototype, Blueprint bluepri
                     // We use MixinAttribute and ListMixinAttribute to differentiate them from RHStructs.
 
                     // First we look for a non-list mixin field
-                    var mixinFieldInfo = classManager.GetMixinFieldInfo(classType, mixinType, typeof(MixinAttribute));
+                    var mixinFieldInfo = classManager.GetMixinFieldInfo(classType, mixinType, PrototypeFieldType.Mixin);
                     if (mixinFieldInfo != null)
                     {
                         // Set owner prototype to the existing mixin instance or create a new instance if there isn't one
@@ -145,12 +143,11 @@ private static bool DeserializeFieldGroup(Prototype prototype, Blueprint bluepri
 
                         // Get the field info from our mixin
                         fieldInfo = classManager.GetFieldInfo(mixinType, blueprintMemberInfo, false);
-                        //Logger.Debug($"Found field info for mixin {mixinType.Name}, field name {blueprintMemberInfo.Member.FieldName}");
                     }
                     else
                     {
                         // Look for a list mixin
-                        mixinFieldInfo = classManager.GetMixinFieldInfo(classType, mixinType, typeof(ListMixinAttribute));
+                        mixinFieldInfo = classManager.GetMixinFieldInfo(classType, mixinType, PrototypeFieldType.ListMixin);
                         if (mixinFieldInfo != null)
                         {
                             PrototypeMixinList list = AcquireOwnedMixinList(prototype, mixinFieldInfo, false);
@@ -162,7 +159,6 @@ private static bool DeserializeFieldGroup(Prototype prototype, Blueprint bluepri
 
                             fieldOwnerPrototype = element;
                             fieldInfo = classManager.GetFieldInfo(mixinType, blueprintMemberInfo, false);
-                            //Logger.Debug($"Found field info for list mixin {mixinType.Name}, field name {blueprintMemberInfo.Member.FieldName}");
                         }
                         else
                         {

src/MHServerEmu/Games/GameData/PrototypeClassManager.cs

@@ -157,11 +157,9 @@ public void BindAssetTypesToEnums(AssetDirectory assetDirectory)
         /// </summary>
         public System.Reflection.PropertyInfo GetFieldInfo(Type prototypeClassType, BlueprintMemberInfo blueprintMemberInfo, bool getPropertyCollection)
         {
+            // Return the C# property info the blueprint member is bound to if we are not looking for a property collection
             if (getPropertyCollection == false)
-            {
-                // Return the C# property info the blueprint member is bound to if we are not looking for a property collection
                 return blueprintMemberInfo.Member.RuntimeClassFieldInfo;
-            }
 
             // TODO: look for a property collection field for this prototype
             return null;
@@ -170,29 +168,32 @@ public System.Reflection.PropertyInfo GetFieldInfo(Type prototypeClassType, Blue
         /// <summary>
         /// Returns a <see cref="System.Reflection.PropertyInfo"/> for a mixin field in a Calligraphy prototype.
         /// </summary>
-        public System.Reflection.PropertyInfo GetMixinFieldInfo(Type ownerClassType, Type fieldClassType, Type mixinAttribute)
+        public System.Reflection.PropertyInfo GetMixinFieldInfo(Type ownerClassType, Type fieldClassType, PrototypeFieldType fieldType)
         {
-            // Make sure we have a valid attribute type
-            if ((mixinAttribute == typeof(MixinAttribute) || mixinAttribute == typeof(ListMixinAttribute)) == false)
-                throw new ArgumentException($"{mixinAttribute.Name} is not a mixin attribute.");
+            // Make sure we have a valid field type enum value
+            if ((fieldType == PrototypeFieldType.Mixin || fieldType == PrototypeFieldType.ListMixin) == false)
+                throw new ArgumentException($"{fieldType} is not a mixin field type.");
 
             // Search the entire class hierarchy for a mixin of the matching type
             while (ownerClassType != typeof(Prototype))
             {
                 // We do what PrototypeFieldSet::GetMixinFieldInfo() does right here using reflection
                 foreach (var property in ownerClassType.GetProperties())
                 {
-                    if (mixinAttribute == typeof(MixinAttribute))
+                    if (fieldType == PrototypeFieldType.Mixin)
                     {
                         // For simple mixins we just return the property if it matches our field type and has the correct attribute
                         if (property.PropertyType != fieldClassType) continue;
-                        if (property.IsDefined(mixinAttribute)) return property;
+                        if (property.IsDefined(typeof(MixinAttribute))) return property;
                     }
-                    else if (mixinAttribute == typeof(ListMixinAttribute))
+                    else if (fieldType == PrototypeFieldType.ListMixin)
                     {
                         // For list mixins we look for a list that is compatible with our requested field type
                         if (property.PropertyType != typeof(PrototypeMixinList)) continue;
 
+                        // NOTE: While we check if the field type defined in the attribute matches our field class type argument exactly,
+                        // the client checks if the argument type is derived from the type defined in the field info.
+                        // This doesn't seem to cause any issues in 1.52, but may need to be changed if we run into issues with other versions.
                         var attribute = property.GetCustomAttribute<ListMixinAttribute>();
                         if (attribute.FieldType == fieldClassType)
                             return property;