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

fix(codegen): Fixes various code gen issues. Adds better embedded serialization support (#688)

Browse source 
* Adds save flag support (see `ElvenGlasses` for an example)
* Updates AOSAttributes so they are code genned
* Fixes embedded object support by adding an `IRawSerializable`
* Fixes various inconsistencies in serializing with codegen
This commit is contained in:
Kamron Batman 2021-08-17 02:43:52 -07:00 • committed by GitHub
parent 69af652a18
commit 2c8097f707
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
54 changed files with 787 additions and 507 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -13,6 +13,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.IO;
@ -113,6 +114,8 @@ namespace SerializationGenerator
compilation.GetTypeByMetadataName(SymbolMetadata.SERIALIZABLE_INTERFACE);
var parentSerializableAttribute =
compilation.GetTypeByMetadataName(SymbolMetadata.SERIALIZABLE_PARENT_ATTRIBUTE);
var serializableFieldSaveFlagAttribute =
compilation.GetTypeByMetadataName(SymbolMetadata.SERIALIZABLE_FIELD_SAVE_FLAG_ATTRIBUTE);
// If we have a parent that is or derives from ISerializable, then we are in override
var isOverride = classSymbol.BaseType.ContainsInterface(serializableInterface);
@ -122,9 +125,28 @@ namespace SerializationGenerator
return null;
}
var isRawSerializable = classSymbol.HasRawSerializableInterface(compilation, ImmutableArray<INamedTypeSymbol>.Empty);
var version = (int)serializableAttr.ConstructorArguments[0].Value!;
var encodedVersion = (bool)serializableAttr.ConstructorArguments[1].Value!;
// Let's find out if we need to do serialization flags
var serializablePropertyFlagGettersSet = new SortedSet<(IMethodSymbol, int)>(new SerializableFieldFlagComparer());
foreach (var m in classSymbol.GetMembers().OfType<IMethodSymbol>())
{
var getSaveFlagAttribute = m.GetAttribute(serializableFieldSaveFlagAttribute);
if (getSaveFlagAttribute == null)
{
continue;
}
var attrCtorArgs = getSaveFlagAttribute.ConstructorArguments;
var order = (int)attrCtorArgs[0].Value!;
serializablePropertyFlagGettersSet.Add((m, order));
}
var serializablePropertyFlagGetters = serializablePropertyFlagGettersSet.ToImmutableArray();
var namespaceName = classSymbol.ContainingNamespace.ToDisplayString();
var className = classSymbol.Name;
@ -133,7 +155,11 @@ namespace SerializationGenerator
source.AppendLine("#pragma warning disable\n");
source.GenerateNamespaceStart(namespaceName);
source.GenerateClassStart(className, ImmutableArray<ITypeSymbol>.Empty);
var interfaces = !embedded || isRawSerializable
? Array.Empty<ITypeSymbol>()
: new ITypeSymbol[] { compilation.GetTypeByMetadataName(SymbolMetadata.RAW_SERIALIZABLE_INTERFACE) };
source.GenerateClassStart(className, " ", interfaces.ToImmutableArray());
const string indent = " ";
@ -224,7 +250,8 @@ namespace SerializationGenerator
allAttributes,
serializableTypes,
embeddedSerializableTypes,
classSymbol
classSymbol,
serializablePropertyFlagGetters.FirstOrDefault(m => m.Item2 == order).Item1
);
serializablePropertySet.Add(serializableProperty);
@ -271,7 +298,7 @@ namespace SerializationGenerator
var migration = migrations[i];
if (migration.Version < version)
{
source.GenerateMigrationContentStruct(migration);
source.GenerateMigrationContentStruct(migration, classSymbol);
source.AppendLine();
}
}
@ -282,7 +309,8 @@ namespace SerializationGenerator
compilation,
isOverride,
encodedVersion,
serializableProperties
serializableProperties,
serializablePropertyFlagGetters
);
source.AppendLine();
@ -295,10 +323,32 @@ namespace SerializationGenerator
encodedVersion,
migrations,
serializableProperties,
parentFieldOrProperty
parentFieldOrProperty,
serializablePropertyFlagGetters
);
source.GenerateClassEnd();
// Serialize SaveFlag enum class
if (serializablePropertyFlagGetters.Length > 0)
{
source.AppendLine();
source.GenerateEnumStart(
"SaveFlag",
" ",
true,
Accessibility.Private
);
int index = 0;
source.GenerateEnumValue(" ", true, "None", index++);
foreach (var (_, order) in serializablePropertyFlagGetters)
{
source.GenerateEnumValue(" ", true, serializableProperties[order].Name, index++);
}
source.GenerateEnumEnd(" ");
}
source.GenerateClassEnd(" ");
source.GenerateNamespaceEnd();
if (migrationPath != null)

46
Projects/SerializationGenerator/SerializableEntityGeneration/SerializableEntityGeneration.DeserializeMethod.cs
View file

@ -32,7 +32,8 @@ namespace SerializationGenerator
bool encodedVersion,
ImmutableArray<SerializableMetadata> migrations,
ImmutableArray<SerializableProperty> properties,
ISymbol parentFieldOrProperty
ISymbol parentFieldOrProperty,
ImmutableArray<(IMethodSymbol, int)> propertyFlagGetters
)
{
var genericReaderInterface = compilation.GetTypeByMetadataName(SymbolMetadata.GENERIC_READER_INTERFACE);
@ -47,6 +48,7 @@ namespace SerializationGenerator
);
const string indent = " ";
const string innerIndent = $"{indent} ";
if (isOverride)
{
@ -89,7 +91,7 @@ namespace SerializationGenerator
source.AppendLine();
source.AppendLine($"{indent}if (version == {migrationVersion})");
source.AppendLine($"{indent}{{");
source.AppendLine($"{indent} MigrateFrom(new V{migrationVersion}Content(reader));");
source.AppendLine($"{indent} MigrateFrom(new V{migrationVersion}Content(reader, this));");
source.AppendLine($"{indent} {parent}.MarkDirty();");
if (afterDeserialization != null)
{
@ -115,17 +117,41 @@ namespace SerializationGenerator
}
}
foreach (var property in properties)
if (propertyFlagGetters.Length > 0)
{
source.AppendLine();
var rule = SerializableMigrationRulesEngine.Rules[property.Rule];
rule.GenerateDeserializationMethod(
source,
indent,
property
);
source.AppendLine($"{indent}var saveFlags = reader.ReadEnum<SaveFlag>();");
}
(rule as IPostDeserializeMethod)?.PostDeserializeMethod(source, indent, property, compilation, classSymbol);
foreach (var property in properties)
{
var usesSaveFlag = propertyFlagGetters.Any(m => m.Item2 == property.Order);
var rule = SerializableMigrationRulesEngine.Rules[property.Rule];
if (usesSaveFlag)
{
source.AppendLine($"\n{indent}if ((saveFlags & SaveFlag.{property.Name}) != 0)\n{indent}{{");
rule.GenerateDeserializationMethod(
source,
innerIndent,
property,
"this"
);
(rule as IPostDeserializeMethod)?.PostDeserializeMethod(source, innerIndent, property, compilation, classSymbol);
source.AppendLine($"{indent}}}");
}
else
{
source.AppendLine();
rule.GenerateDeserializationMethod(
source,
indent,
property,
"this"
);
(rule as IPostDeserializeMethod)?.PostDeserializeMethod(source, indent, property, compilation, classSymbol);
}
}
if (afterDeserialization != null)

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

@ -13,6 +13,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System.Collections.Immutable;
using System.Linq;
using System.Text;
using Microsoft.CodeAnalysis;
@ -28,7 +29,7 @@ namespace SerializationGenerator
Accessibility getter,
Accessibility? setter,
bool isVirtual,
ISymbol? parentFieldOrProperty = null
ISymbol? parentFieldOrProperty
)
{
var fieldName = fieldSymbol.Name;

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

@ -14,6 +14,7 @@
*************************************************************************/
using System.Collections.Immutable;
using System.Linq;
using System.Text;
using Microsoft.CodeAnalysis;
using SerializableMigration;
@ -27,7 +28,8 @@ namespace SerializationGenerator
Compilation compilation,
bool isOverride,
bool encodedVersion,
ImmutableArray<SerializableProperty> properties
ImmutableArray<SerializableProperty> properties,
ImmutableArray<(IMethodSymbol, int)> propertyFlagGetters
)
{
var genericWriterInterface = compilation.GetTypeByMetadataName(SymbolMetadata.GENERIC_WRITER_INTERFACE);
@ -42,6 +44,7 @@ namespace SerializationGenerator
);
const string indent = " ";
const string innerIndent = $"{indent} ";
if (isOverride)
{
@ -52,14 +55,47 @@ namespace SerializationGenerator
// Version
source.AppendLine($"{indent}writer.{(encodedVersion ? "WriteEncodedInt" : "Write")}(_version);");
// Let's collect the flags
if (propertyFlagGetters.Length > 0)
{
source.AppendLine($"\n{indent}var saveFlags = SaveFlag.None;");
foreach (var (m, order) in propertyFlagGetters)
{
source.AppendLine($"{indent}if ({m.Name}())\n{indent}{{");
var propertyName = properties[order].Name;
source.AppendLine($"{innerIndent}saveFlags |= SaveFlag.{propertyName};");
source.AppendLine($"{indent}}}");
}
source.AppendLine($"{indent}writer.WriteEnum(saveFlags);");
}
foreach (var property in properties)
{
source.AppendLine();
SerializableMigrationRulesEngine.Rules[property.Rule].GenerateSerializationMethod(
source,
indent,
property
);
var usesSaveFlag = propertyFlagGetters.Any(m => m.Item2 == property.Order);
if (usesSaveFlag)
{
source.AppendLine($"\n{indent}if ((saveFlags & SaveFlag.{property.Name}) != 0)\n{indent}{{");
SerializableMigrationRulesEngine.Rules[property.Rule].GenerateSerializationMethod(
source,
innerIndent,
property
);
source.AppendLine($"{indent}}}");
}
else
{
source.AppendLine();
SerializableMigrationRulesEngine.Rules[property.Rule].GenerateSerializationMethod(
source,
indent,
property
);
}
}
source.GenerateMethodEnd(" ");

72
Projects/SerializationGenerator/SerializableEntityGeneration/SerializationGenerator.ContentStruct.cs
View file

@ -13,7 +13,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System.Linq;
using System.Text;
using Microsoft.CodeAnalysis;
using SerializableMigration;
namespace SerializationGenerator
@ -22,7 +24,8 @@ namespace SerializationGenerator
{
public static void GenerateMigrationContentStruct(
this StringBuilder source,
SerializableMetadata migration
SerializableMetadata migration,
INamedTypeSymbol classSymbol
)
{
const string indent = " ";
@ -34,16 +37,69 @@ namespace SerializationGenerator
source.AppendLine($"{indent} internal readonly {serializableProperty.Type} {serializableProperty.Name};");
}
source.AppendLine($"{indent} internal V{migration.Version}Content(IGenericReader reader)");
var innerIndent = $"{indent} ";
var usesSaveFlags = migration.Properties.Any(p => p.UsesSaveFlag == true);
if (usesSaveFlags)
{
source.AppendLine();
source.GenerateEnumStart(
$"V{migration.Version}SaveFlag",
$"{indent} ",
true,
Accessibility.Private
);
int index = 0;
source.GenerateEnumValue(innerIndent, true, "None", index++);
foreach (var property in migration.Properties)
{
if (property.UsesSaveFlag == true)
{
source.GenerateEnumValue(innerIndent, true, property.Name, index++);
}
}
source.GenerateEnumEnd($"{indent} ");
}
source.AppendLine($"{indent} internal V{migration.Version}Content(IGenericReader reader, {classSymbol.ToDisplayString()} entity)");
source.AppendLine($"{indent} {{");
foreach (var serializableProperty in migration.Properties)
if (usesSaveFlags)
{
SerializableMigrationRulesEngine.Rules[serializableProperty.Rule].GenerateDeserializationMethod(
source,
$"{indent} ",
serializableProperty
);
source.AppendLine($"{innerIndent}var saveFlags = reader.ReadEnum<V{migration.Version}SaveFlag>();");
}
if (migration.Properties.Length > 0)
{
source.AppendLine();
foreach (var property in migration.Properties)
{
if (property.UsesSaveFlag == true)
{
source.AppendLine($"\n{innerIndent}if ((saveFlags & V{migration.Version}SaveFlag.{property.Name}) != 0)\n{innerIndent}{{");
SerializableMigrationRulesEngine.Rules[property.Rule].GenerateDeserializationMethod(
source,
$"{innerIndent} ",
property,
"entity"
);
source.AppendLine($"{innerIndent}}}\n{innerIndent}else\n{innerIndent}{{");
source.AppendLine($"{innerIndent} {property.Name} = default;");
source.AppendLine($"{innerIndent}}}");
}
else
{
SerializableMigrationRulesEngine.Rules[property.Rule].GenerateDeserializationMethod(
source,
innerIndent,
property,
"entity"
);
}
}
}
source.AppendLine($"{indent} }}");