fix(core): Fixes encoded int. Adds dirty checking opt-out (#619)
### 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
GitHub
parent
1f499b00c6
commit
312e3873f1
13 changed files with 99 additions and 58 deletions
|
|
@ -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();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -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();");
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ namespace SerializationGenerator
|
|||
|
||||
if (!isOverride)
|
||||
{
|
||||
source.Append(@$" Serial = serial;
|
||||
source.AppendLine(@$" Serial = serial;
|
||||
SetTypeRef(typeof({className}));");
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -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();
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue