warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

fix(core): Fixes encoded int. Adds dirty checking opt-out (#619)

Browse source 
### Additions
- Automatically opts-out `Item/Mobile/Guild/Accounts` from dirty checking with a new property `UseDirtyChecking`
- Codegen now enables `UseDirtyChecking` via getter. This requires that the property is `virtual` for derived types.

### Fixes
- Fixes `EncodedInt` being broken
- Fixes issues with new custom serializable types that are not derived from Item/Mobile/etc.
- Removes double dirty checking.

### Example of a brand new serializable type that isn't an Item/Mobile/etc.
User created code:
```cs
using System;

namespace Server.Items
{
    [Serializable(0)]
    public partial class NewTestEntityObject : ISerializable
    {
        [EncodedInt]
        [SerializableField(0)]
        private int _someProperty;

        public NewTestEntityObject()
        {
            SetTypeRef(GetType());
            // Add to serial tracking like World.Item
            /*
            Serial = World.NewEntity;
            World.AddEntity(this);
            */
        }

        [AfterDeserialization]
        private void AfterDeserialization()
        {
            Console.WriteLine("This ran!");
        }

        public int TypeRef { get; }
        public Serial Serial { get; }
        public void Delete()
        {
        }

        public bool Deleted { get; set; }
        public void SetTypeRef(Type type)
        {
            // Type tracking for persistence goes here
            /*
            TypeRef = World.NewEntityTypes.IndexOf(type);
            if (TypeRef == -1)
            {
                World.NewEntityTypes.Add(type);
                TypeRef = World.NewEntityTypes.Count - 1;
            }
            */
        }
    }
}
```

Generated code:
```cs
namespace Server.Items
{
    public partial class NewTestEntityObject
    {
#pragma warning disable 0414
        private const int _version = 0;
#pragma warning restore 0414

        public int SomeProperty
        {
            get => _someProperty;
            set
            {
                if (value != _someProperty)
                {
                    _someProperty = value;
                    ((ISerializable)this).MarkDirty();
                }
            }
        }

        long ISerializable.SavePosition { get; set; } = -1;
        BufferWriter ISerializable.SaveBuffer { get; set; }
        bool ISerializable.UseDirtyChecking => true;

        public NewTestEntityObject(Serial serial)
        {
            Serial = serial;
            SetTypeRef(typeof(NewTestEntityObject));
        }

        public void Serialize(IGenericWriter writer)
        {

            writer.WriteEncodedInt(_version);

            writer.WriteEncodedInt(SomeProperty);
        }

        public void Deserialize(IGenericReader reader)
        {
            var version = reader.ReadEncodedInt();

            SomeProperty = reader.ReadEncodedInt();

            Timer.DelayCall(AfterDeserialization);
        }
    }
}
```
This commit is contained in:
Kamron Batman 2021-05-26 19:25:05 -07:00 • committed by GitHub
parent 1f499b00c6
commit 312e3873f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 99 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

43
Projects/SerializationGenerator/SerializableEntityGeneration/SerializableEntityGeneration.Class.cs
View file

@ -101,11 +101,11 @@ namespace SerializationGenerator
source.GenerateClassStart(
className,
isOverride ?
ImmutableArray<ITypeSymbol>.Empty :
ImmutableArray.Create<ITypeSymbol>(serializableInterface)
ImmutableArray<ITypeSymbol>.Empty
);
const string indent = " ";
source.GenerateClassField(
AccessModifier.Private,
InstanceModifier.Const,
@ -199,15 +199,16 @@ namespace SerializationGenerator
// If we are not inheriting ISerializable, then we need to define some stuff
if (!isOverride)
{
// long ISerializable.SavePosition { get; set; }
// long ISerializable.SavePosition { get; set; } = -1;
source.GenerateAutoProperty(
AccessModifier.None,
"long",
"ISerializable.SavePosition",
AccessModifier.None,
AccessModifier.None
AccessModifier.None,
indent,
defaultValue: "-1"
);
source.AppendLine();
// BufferWriter ISerializable.SaveBuffer { get; set; }
source.GenerateAutoProperty(
@ -215,7 +216,35 @@ namespace SerializationGenerator
"BufferWriter",
"ISerializable.SaveBuffer",
AccessModifier.None,
AccessModifier.None
AccessModifier.None,
indent
);
// bool ISerializable.UseDirtyChecking { get; } = true;
source.GenerateAutoProperty(
AccessModifier.None,
"bool",
"ISerializable.UseDirtyChecking",
AccessModifier.None,
null,
indent,
defaultValue: "true"
);
source.AppendLine();
}
else
{
// If this type does not *directly* inherit `ISerializable`, then we assume it has an overridable `UseDirtyChecking`
// public override bool ISerializable.UseDirtyChecking { get; } = true;
source.GenerateAutoProperty(
AccessModifier.Public,
"bool",
"UseDirtyChecking",
AccessModifier.None,
null,
indent,
defaultValue: "true",
isOverride: true
);
source.AppendLine();
}

2
Projects/SerializationGenerator/SerializableEntityGeneration/SerializableEntityGeneration.Property.cs
View file

@ -47,7 +47,7 @@ namespace SerializationGenerator
// Setter
source.GeneratePropertySetterStart(false);
const string indent = " ";
source.AppendLine($"{indent}if(value != {fieldName})");
source.AppendLine($"{indent}if (value != {fieldName})");
source.AppendLine($"{indent}{{");
source.AppendLine($"{indent} {fieldName} = value;");
source.AppendLine($"{indent} ((ISerializable)this).MarkDirty();");

2
Projects/SerializationGenerator/SerializableEntityGeneration/SerializableEntityGeneration.SerialCtor.cs
View file

@ -40,7 +40,7 @@ namespace SerializationGenerator
if (!isOverride)
{
source.Append(@$" Serial = serial;
source.AppendLine(@$" Serial = serial;
SetTypeRef(typeof({className}));");
}

7
Projects/SerializationGenerator/SerializableEntityGeneration/SerializableEntityGeneration.SerializeMethod.cs
View file

@ -41,13 +41,6 @@ namespace SerializationGenerator
const string indent = " ";
source.AppendLine($"{indent}var savePosition = ((Server.ISerializable)this).SavePosition;");
source.AppendLine(@$"{indent}if (savePosition > -1)
{indent}{{
{indent} writer.Seek(savePosition, System.IO.SeekOrigin.Begin);
{indent} return;
{indent}}}");
if (isOverride)
{
source.AppendLine();

56
Projects/SerializationGenerator/SerializableMigration/Rules/PrimitiveTypeMigrationRule.cs
View file

@ -87,34 +87,33 @@ namespace SerializationGenerator
}
var propertyName = property.Name;
var argument = property.RuleArguments.Length >= 1 ? property.RuleArguments[0] : null;
const string ipAddress = SerializableEntityGeneration.IPADDRESS_CLASS;
const string date = "System.DateTime";
var readMethod = property.Type switch
{
"bool" => "ReadBool",
"sbyte" => "ReadSByte",
"short" => "ReadShort",
"int" => "ReadInt",
"long" => "ReadLong",
"byte" => "ReadByte",
"ushort" => "ReadUShort",
"uint" => "ReadUInt",
"ulong" => "ReadULong",
"float" => "ReadFloat",
"double" => "ReadDouble",
"string" => "ReadString",
"decimal" => "ReadDecimal",
ipAddress => "ReadIPAddress",
"System.DateTime" => property.RuleArguments.Length >= 1 &&
property.RuleArguments[0] == "DeltaTime" ?
"ReadDeltaTime" :
"ReadDateTime"
"bool" => "ReadBool",
"sbyte" => "ReadSByte",
"short" => "ReadShort",
"int" when argument == "EncodedInt" => "ReadEncodedInt",
"int" => "ReadInt",
"long" => "ReadLong",
"byte" => "ReadByte",
"ushort" => "ReadUShort",
"uint" => "ReadUInt",
"ulong" => "ReadULong",
"float" => "ReadFloat",
"double" => "ReadDouble",
"string" => "ReadString",
"decimal" => "ReadDecimal",
date when argument == "DeltaTime" => "ReadDeltaTime",
date => "ReadDateTime",
ipAddress => "ReadIPAddress"
};
var readArgument = readMethod == "ReadString" &&
property.RuleArguments.Length >= 1 &&
property.RuleArguments[0] == "InternString" ? "true" : "";
var readArgument = readMethod == "ReadString" && argument == "InternString" ? "true" : "";
source.AppendLine($"{indent}{propertyName} = reader.{readMethod}({readArgument});");
}
@ -129,15 +128,16 @@ namespace SerializationGenerator
}
var propertyName = property.Name;
var argument = property.RuleArguments.Length >= 1 ? property.RuleArguments[0] : null;
if (property.Type == "System.DateTime" && property.RuleArguments.Length >= 1 && property.RuleArguments[0] == "DeltaTime")
var writeMethod = property.Type switch
{
source.AppendLine($"{indent}writer.WriteDeltaTime({propertyName});");
}
else
{
source.AppendLine($"{indent}writer.Write({propertyName});");
}
"System.DateTime" when argument == "DeltaTime" => "WriteDeltaTime",
"int" when argument == "EncodedInt" => "WriteEncodedInt",
_ => "Write"
};
source.AppendLine($"{indent}writer.{writeMethod}({propertyName});");
}
}
}

17
Projects/SerializationGenerator/SourceGeneration/SourceGeneration.Property.cs
View file

@ -59,7 +59,10 @@ namespace SerializationGenerator
string propertyName,
AccessModifier? getAccessor,
AccessModifier? setAccessor,
bool useInit = false
string indent,
bool useInit = false,
string defaultValue = null,
bool isOverride = false
)
{
if (getAccessor == null && setAccessor == null)
@ -74,12 +77,18 @@ namespace SerializationGenerator
var getterSpace = getAccessor != null ? " " : "";
var setOrInit = useInit ? "init;" : "set;";
var setterAccessor = setAccessor != AccessModifier.None ? $"{setAccessor?.ToFriendlyString() ?? ""} " : "";
var setter = setterAccessor == "" ? "" : $"{getterSpace}{setterAccessor}{setOrInit}";
var setterAccessor = setAccessor is null or AccessModifier.None
? ""
: $"{setAccessor.Value.ToFriendlyString() ?? ""} ";
var setter = setAccessor == null ? "" : $"{getterSpace}{setterAccessor}{setOrInit}";
var propertyAccessor = accessors == AccessModifier.None ? "" : $"{accessors.ToFriendlyString()} ";
var printOverride = isOverride ? "override " : "";
var printDefaultValue = defaultValue != null ? $"{(setAccessor != null ? " =" : "")} {defaultValue};" : "";
var printGetterSetter = setAccessor == null ? "=>" : $"{{ {getter}{setter} }}";
source.AppendLine($"{propertyAccessor}{type} {propertyName} {{ {getter}{setter} }}");
source.AppendLine($"{indent}{propertyAccessor}{printOverride}{type} {propertyName} {printGetterSetter}{printDefaultValue}");
}
public static void GeneratePropertyEnd(this StringBuilder source) => source.AppendLine(" }");