RobustToolbox/Robust.Serialization.Generator/Generator.cs

using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Text;
using Robust.Roslyn.Shared;
using static Robust.Roslyn.Shared.DataDefinitionHelper;
using static Robust.Serialization.Generator.CustomSerializerType;
using static Robust.Serialization.Generator.Types;

namespace Robust.Serialization.Generator;

[Generator]
public class Generator : IIncrementalGenerator
{
    private const string TypeCopierInterfaceNamespace =
        "Robust.Shared.Serialization.TypeSerializers.Interfaces.ITypeCopier";

    private const string TypeCopyCreatorInterfaceNamespace =
        "Robust.Shared.Serialization.TypeSerializers.Interfaces.ITypeCopyCreator";

    private const string TypeValidatorInterfaceNamespace =
        "Robust.Shared.Serialization.TypeSerializers.Interfaces.ITypeValidator";

    private const string TypeReaderInterfaceNamespace =
        "Robust.Shared.Serialization.TypeSerializers.Interfaces.ITypeReader";

    private const string TypeWriterInterfaceNamespace =
        "Robust.Shared.Serialization.TypeSerializers.Interfaces.ITypeWriter";

    private const string SerializationHooksNamespace = "Robust.Shared.Serialization.ISerializationHooks";
    private const string AutoStateAttributeName = "Robust.Shared.Analyzers.AutoGenerateComponentStateAttribute";
    private const string ComponentDeltaInterfaceName = "Robust.Shared.GameObjects.IComponentDelta";
    private const string MappingDataNodeName = "Robust.Shared.Serialization.Markdown.Mapping.MappingDataNode";
    private const string SequenceDataNodeName = "Robust.Shared.Serialization.Markdown.Sequence.SequenceDataNode";
    private const string ValueDataNodeName = "Robust.Shared.Serialization.Markdown.Value.ValueDataNode";
    private const string EntityUidName = "Robust.Shared.GameObjects.EntityUid";
    private const string ComponentName = "Robust.Shared.GameObjects.Component";

    public void Initialize(IncrementalGeneratorInitializationContext initContext)
    {
        IncrementalValuesProvider<(string name, string code)?> dataDefinitions = initContext.SyntaxProvider
            .CreateSyntaxProvider(
                static (node, _) => IsCandidateTypeDeclaration(node),
                static (context, cancellationToken) =>
                {
                    var type = (TypeDeclarationSyntax)context.Node;
                    if (context.SemanticModel.GetDeclaredSymbol(type, cancellationToken) is not INamedTypeSymbol symbol)
                        return null;

                    if (symbol.TypeKind == TypeKind.Interface ||
                        !IsCanonicalCandidateDeclaration(type, symbol, cancellationToken) ||
                        !IsDataDefinition(symbol, out var isDataRecord))
                    {
                        return null;
                    }

                    return GenerateForDataDefinition(type, symbol, isDataRecord, cancellationToken);
                }
            )
            .Where(static type => type != null);

        initContext.RegisterSourceOutput(
            dataDefinitions,
            static (sourceContext, source) =>
            {
                var (name, code) = source!.Value;
                sourceContext.AddSource(name, SourceText.From(code, Encoding.UTF8));
            });
    }

    private static bool IsCandidateTypeDeclaration(SyntaxNode node)
    {
        return node is TypeDeclarationSyntax { AttributeLists.Count: > 0 } and not InterfaceDeclarationSyntax ||
               node is TypeDeclarationSyntax { BaseList: not null } and not InterfaceDeclarationSyntax;
    }

    private static bool IsCanonicalCandidateDeclaration(
        TypeDeclarationSyntax declaration,
        INamedTypeSymbol symbol,
        CancellationToken cancellationToken)
    {
        TypeDeclarationSyntax? canonical = null;

        foreach (var reference in symbol.DeclaringSyntaxReferences)
        {
            if (reference.GetSyntax(cancellationToken) is not TypeDeclarationSyntax syntax ||
                !IsCandidateTypeDeclaration(syntax))
            {
                continue;
            }

            if (canonical == null || CompareDeclarations(syntax, canonical) < 0)
                canonical = syntax;
        }

        return canonical == declaration;
    }

    private static int CompareDeclarations(TypeDeclarationSyntax left, TypeDeclarationSyntax right)
    {
        var pathComparison = string.Compare(
            left.SyntaxTree.FilePath,
            right.SyntaxTree.FilePath,
            StringComparison.Ordinal);

        if (pathComparison != 0)
            return pathComparison;

        return left.SpanStart.CompareTo(right.SpanStart);
    }

    private static (string, string)? GenerateForDataDefinition(
        TypeDeclarationSyntax declaration,
        INamedTypeSymbol type,
        bool isDataRecord,
        CancellationToken cancellationToken)
    {
        var builder = new StringBuilder();
        var containingTypes = new Stack<INamedTypeSymbol>();
        containingTypes.Clear();

        var symbolName = type
            .ToDisplayString()
            .Replace('<', '{')
            .Replace('>', '}');

        var nonPartial = !IsPartial(declaration);

        var namespaceString = type.ContainingNamespace.IsGlobalNamespace
            ? string.Empty
            : $"namespace {type.ContainingNamespace.ToDisplayString()};";

        var containingType = type.ContainingType;
        while (containingType != null)
        {
            containingTypes.Push(containingType);
            containingType = containingType.ContainingType;
        }

        var containingTypesStart = new StringBuilder();
        var containingTypesEnd = new StringBuilder();
        foreach (var parent in containingTypes)
        {
            var syntax = (TypeDeclarationSyntax)parent.DeclaringSyntaxReferences[0].GetSyntax(cancellationToken);
            if (!IsPartial(syntax))
            {
                nonPartial = true;
                continue;
            }

            containingTypesStart.AppendLine($"{GetPartialTypeDefinitionLine(parent)}\n{{");
            containingTypesEnd.AppendLine("}");
        }

        var definition = GetDataDefinition(type, isDataRecord);
        if (nonPartial || definition.InvalidFields)
            return null;

        builder.AppendLine($$"""
            #nullable enable
            using System;
            using System.Collections.Generic;
            using System.Collections.Immutable;
            using System.Diagnostics.CodeAnalysis;
            using Robust.Shared.Analyzers;
            using Robust.Shared.IoC;
            using Robust.Shared.GameObjects;
            using Robust.Shared.Serialization;
            using Robust.Shared.Serialization.Manager;
            using Robust.Shared.Serialization.Manager.Definition;
            using Robust.Shared.Serialization.Manager.Exceptions;
            using Robust.Shared.Serialization.Markdown;
            using Robust.Shared.Serialization.Markdown.Mapping;
            using Robust.Shared.Serialization.Markdown.Sequence;
            using Robust.Shared.Serialization.Markdown.Validation;
            using Robust.Shared.Serialization.Markdown.Value;
            using Robust.Shared.Serialization.TypeSerializers.Interfaces;
            #pragma warning disable CS0618 // Type or member is obsolete
            #pragma warning disable CS0612 // Type or member is obsolete
            #pragma warning disable CS0108 // Member hides inherited member; missing new keyword
            #pragma warning disable RA0002 // Robust access analyzer

            {{namespaceString}}

            {{containingTypesStart}}

            {{GetPartialTypeDefinitionLine(type)}} : ISerializationGenerated<{{definition.GenericTypeName}}>
            {
                {{GetConstructors(definition)}}

                {{GetInstantiators(definition)}}

                {{GetCopiers(definition)}}

                {{GetReaders(definition)}}

                {{GetWriter(definition)}}

                {{GetEquality(definition)}}

                {{GetValidator(definition)}}

                {{GetFieldDefinitions(definition)}}
            }

            {{containingTypesEnd}}
            """);

        return ($"{symbolName}.g.cs", builder.ToString());
    }

    private static void GetDataFields(
        ITypeSymbol definition,
        bool isDataRecord,
        List<DataField> fields,
        List<INamedTypeSymbol> symbols,
        ref bool invalidFields)
    {
        foreach (var (field, fieldType, attribute) in GetAllDataFields(definition, isDataRecord))
        {
            var existingIndex = fields.FindIndex(existing =>
                SymbolEqualityComparer.Default.Equals(existing.Symbol, field));
            if (existingIndex != -1)
            {
                if (fields[existingIndex].Attribute.Data != null || attribute.Data == null)
                    continue;

                fields.RemoveAt(existingIndex);
            }

            if (!IsDataDefinition(field.ContainingType, out _))
                invalidFields = true;

            if (attribute.Data?.ConstructorArguments.FirstOrDefault(arg => arg.Kind == TypedConstantKind.Type).Value is
                INamedTypeSymbol customSerializer)
            {
                var serializerType = None;
                if (ImplementsInterface(customSerializer, TypeCopierInterfaceNamespace))
                    serializerType |= Copier;
                else if (ImplementsInterface(customSerializer, TypeCopyCreatorInterfaceNamespace))
                    serializerType |= CopyCreator;

                if (ImplementsInterface(customSerializer, TypeValidatorInterfaceNamespace, symbols))
                {
                    foreach (var symbol in symbols)
                    {
                        if (symbol.IsGenericType &&
                            symbol.TypeArguments is { Length: >= 2 } arguments)
                        {
                            var nodeType = arguments[1];
                            if (nodeType.ToDisplayString().Contains(MappingDataNodeName))
                                serializerType |= MappingValidator;

                            if (nodeType.ToDisplayString().Contains(SequenceDataNodeName))
                                serializerType |= SequenceValidator;

                            if (nodeType.ToDisplayString().Contains(ValueDataNodeName))
                                serializerType |= ValueValidator;
                        }
                    }
                }

                if (ImplementsInterface(customSerializer, TypeReaderInterfaceNamespace, symbols))
                {
                    foreach (var symbol in symbols)
                    {
                        if (symbol.IsGenericType &&
                            symbol.TypeArguments is { Length: >= 2 } arguments)
                        {
                            var nodeType = arguments[1];
                            if (nodeType.ToDisplayString().Contains(MappingDataNodeName))
                                serializerType |= MappingReader;

                            if (nodeType.ToDisplayString().Contains(SequenceDataNodeName))
                                serializerType |= SequenceReader;

                            if (nodeType.ToDisplayString().Contains(ValueDataNodeName))
                                serializerType |= ValueReader;
                        }
                    }
                }

                if (ImplementsInterface(customSerializer, TypeWriterInterfaceNamespace, symbols))
                    serializerType |= Writer;

                if (serializerType != None)
                {
                    fields.Add(new DataField(field, fieldType, attribute, (customSerializer, serializerType)));
                    continue;
                }
            }

            fields.Add(new DataField(field, fieldType, attribute, null));

            if (IsReadOnlyMember(definition, fieldType))
                invalidFields = true;
        }
    }

    private static DataDefinition GetDataDefinition(ITypeSymbol definition, bool isDataRecord)
    {
        var fields = new List<DataField>();
        var symbols = new List<INamedTypeSymbol>();
        var invalidFields = false;

        GetDataFields(definition, isDataRecord, fields, symbols, ref invalidFields);

        var typeName = GetGenericTypeName(definition);
        var hasHooks = ImplementsInterface(definition, SerializationHooksNamespace);

        // Same as DataDefinition.cs
        fields.Sort((a, b) =>
        {
            var priority = b.Attribute.Priority.CompareTo(a.Attribute.Priority);
            if (priority != 0)
                return priority;

            return string.Compare(b.Symbol.Name, a.Symbol.Name, StringComparison.OrdinalIgnoreCase);
        });

        return new DataDefinition(definition, typeName, fields, hasHooks, invalidFields, isDataRecord);
    }

    private static string GetConstructors(DataDefinition definition)
    {
        if (definition.Type.TypeKind == TypeKind.Interface)
            return string.Empty;

        var builder = new StringBuilder();
        var thisCall = new StringBuilder();
        var (needsEmpty, mustCall) = NeedsEmptyConstructor(definition.Type);
        if (mustCall != null)
        {
            thisCall.Append(" : this(");
            foreach (var parameter in mustCall.Parameters)
            {
                thisCall.Append($"{GetParameterDefaultExpression(parameter)},");
            }

            if (thisCall[thisCall.Length - 1] == ',')
                thisCall = thisCall.Remove(thisCall.Length - 1, 1);

            thisCall.Append(')');
        }

        var setsRequired = GetSetsRequiredAttributeOrEmpty(definition.Type);
        if (needsEmpty)
        {
            // There was one case in content of a content-defined constructor calling the source-generated
            // empty constructor, which would then call it again.
            // Instead of attempting to find loops like this, I changed content.
            // Because that's fucking stupid.
            builder.AppendLine($$"""
                // Implicit constructor
                #pragma warning disable CS8618
                {{setsRequired}}
                public {{definition.Type.Name}}(){{thisCall}}
                #pragma warning restore CS8618
                {
                }
                """);
        }

        var accessibility = definition.Type.IsValueType
            ? "public"
            : definition.Type.IsSealed
                ? "private"
                : "protected";

        var copyBaseCall = definition.IsDataDefinition(definition.Type.BaseType, out _)
            ? "base(ISerializationGeneratedCopy, source, serialization, hookCtx, context)"
            : "this()";

        var readBaseCall = definition.IsDataDefinition(definition.Type.BaseType, out _)
            ? "base(ISerializationGeneratedRead, mappingDataNode, serialization, hookCtx, context)"
            : "this()";

        builder.AppendLine($$"""
            [Obsolete("Used only in serialization source generation internally")]
            #pragma warning disable CS8618
            {{setsRequired}}
            {{accessibility}} {{definition.Type.Name}}(
                ISerializationGeneratedCopy ISerializationGeneratedCopy,
                {{definition.GenericTypeName}} source,
                ISerializationManager serialization,
                SerializationHookContext hookCtx,
                ISerializationContext? context
            ) : {{copyBaseCall}}
            #pragma warning restore CS8618
            {
                {{GetCopyBody(definition)}}
            }

            [Obsolete("Used only in serialization source generation internally")]
            #pragma warning disable CS8618
            {{setsRequired}}
            {{accessibility}} {{definition.Type.Name}}(
                ISerializationGeneratedRead ISerializationGeneratedRead,
                MappingDataNode mappingDataNode,
                ISerializationManager serialization,
                SerializationHookContext hookCtx,
                ISerializationContext? context
            ) : {{readBaseCall}}
            #pragma warning restore CS8618
            {
                {{GetReadBody(definition)}}
            }
            """);

        return builder.ToString();
    }

    private static string GetParameterDefaultExpression(IParameterSymbol parameter)
    {
        var typeName = parameter.Type.ToDisplayString();
        if (!parameter.HasExplicitDefaultValue)
            return $"({typeName}) default!";

        var value = parameter.ExplicitDefaultValue;
        if (value == null)
            return parameter.Type.IsValueType ? "default!" : "null!";

        var literal = parameter.Type.SpecialType switch
        {
            SpecialType.System_Boolean => (bool)value ? "true" : "false",
            SpecialType.System_Char => SyntaxFactory.LiteralExpression(
                SyntaxKind.CharacterLiteralExpression,
                SyntaxFactory.Literal((char)value)).ToFullString(),
            SpecialType.System_String => SyntaxFactory.LiteralExpression(
                SyntaxKind.StringLiteralExpression,
                SyntaxFactory.Literal((string)value)).ToFullString(),
            SpecialType.System_Single => Convert.ToString(value, CultureInfo.InvariantCulture) + "f",
            SpecialType.System_Double => Convert.ToString(value, CultureInfo.InvariantCulture) + "d",
            SpecialType.System_Decimal => Convert.ToString(value, CultureInfo.InvariantCulture) + "m",
            SpecialType.System_UInt32 => Convert.ToString(value, CultureInfo.InvariantCulture) + "U",
            SpecialType.System_Int64 => Convert.ToString(value, CultureInfo.InvariantCulture) + "L",
            SpecialType.System_UInt64 => Convert.ToString(value, CultureInfo.InvariantCulture) + "UL",
            _ => Convert.ToString(value, CultureInfo.InvariantCulture) ?? "default!"
        };

        if (literal.StartsWith("-", StringComparison.Ordinal))
            literal = $"({literal})";

        return $"({typeName}) {literal}";
    }

    private static string GetReadBody(DataDefinition definition, string targetPrefix = "this")
    {
        var builder = new StringBuilder();
        for (var i = 0; i < definition.Fields.Count; i++)
        {
            var field = definition.Fields[i];
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            if (field.Attribute.ServerOnly)
            {
                builder.AppendLine("""
                    if (serialization.IsServer)
                    {
                    """);
            }

            var fieldName = field.Symbol.Name;
            var targetName = $"{targetPrefix}.{fieldName}";
            if (field.Attribute.IsDataFieldAttribute)
            {
                builder.AppendLine($$"""
                    if (mappingDataNode.TryGet("{{field.Attribute.Tag}}", out var node{{i}}))
                    {
                    """);
            }
            else
            {
                builder.AppendLine($$"""
                    {
                        var node{{i}} = mappingDataNode;
                    """);
            }

            var (fieldTypeName, nonNullableFieldTypeName) = GetCleanNameForGenericType(field.Type, out _);
            var tagName = field.Attribute.Tag;
            var reader = field.CustomSerializer;
            var readerName = reader?.Serializer.ToDisplayString();
            var nullable = field.Type.NullableAnnotation == NullableAnnotation.Annotated ||
                           field.Type.ToDisplayString().EndsWith("?");
            var nullableString = string.Empty;
            if (!field.Type.IsValueType)
            {
                nullableString = $", {(!nullable).ToString().ToLowerInvariant()}";
                if (fieldTypeName.EndsWith("?"))
                    fieldTypeName = fieldTypeName.Substring(0, fieldTypeName.Length - 1);
            }

            var nullExpression =
                field.Type.WithNullableAnnotation(NullableAnnotation.None).ToDisplayString().Equals(EntityUidName)
                    ? $"{targetName} = EntityUid.Invalid;"
                    : nullable
                        ? $"{targetName} = default!;"
                        : "throw new NullNotAllowedException();";

            builder.AppendLine($$"""
                if (node{{i}}.IsNull)
                {
                    {{nullExpression}}
                }
                else
                {
                """);

            var method = $"Read<{fieldTypeName}>";
            if (field.Type.TypeKind == TypeKind.Enum)
            {
                method = $"ReadEnum<{fieldTypeName}>";
                nullableString = string.Empty;
            }
            else if (field.Type.IsValueType && definition.IsDataDefinition(field.Type, out _))
            {
                method = $"ReadStructDefinition<{fieldTypeName}>";
                nullableString = string.Empty;
            }
            else if (field.Type.TypeKind == TypeKind.Array &&
                     field.Type is IArrayTypeSymbol { Rank: 1 } arrayTypeSymbol) // [*,*] goes the regular way
            {
                var elementType = arrayTypeSymbol.ElementType;
                method = $"ReadArray<{elementType}>";

                if (elementType.NullableAnnotation != NullableAnnotation.Annotated &&
                    !elementType.ToDisplayString().EndsWith("?") &&
                    !elementType.IsValueType)
                {
                    nullableString = $", {(!nullable).ToString().ToLowerInvariant()}";
                }
                else
                {
                    nullableString = string.Empty;
                }
            }
            else if (definition.IsDataDefinition(field.Type, out _) && field.Type.TypeKind != TypeKind.Interface)
            {
                method = $"ReadDefinition<{fieldTypeName}>";
            }

            if (reader is { Type: var type } &&
                (type & (MappingReader | SequenceReader | ValueReader)) != 0)
            {
                builder.AppendLine($$"""
                    switch (node{{i}})
                    {
                    """);

                if ((reader.Value.Type & MappingReader) != 0)
                {
                    builder.AppendLine($"""
                        case MappingDataNode mapping:
                            {targetName} = serialization.Read<{nonNullableFieldTypeName}, MappingDataNode, {readerName}>(mapping, hookCtx, context, null{nullableString});
                            break;
                        """);
                }

                if ((reader.Value.Type & SequenceReader) != 0)
                {
                    builder.AppendLine($"""
                        case SequenceDataNode sequence:
                            {targetName} = serialization.Read<{nonNullableFieldTypeName}, SequenceDataNode, {readerName}>(sequence, hookCtx, context, null{nullableString});
                            break;
                        """);
                }

                if ((reader.Value.Type & ValueReader) != 0)
                {
                    builder.AppendLine($"""
                        case ValueDataNode value:
                            {targetName} = serialization.Read<{nonNullableFieldTypeName}, ValueDataNode, {readerName}>(value, hookCtx, context, null{nullableString});
                            break;
                        """);
                }

                builder.AppendLine($$"""
                    default:
                        throw new InvalidOperationException($"Unable to read node for {{field.Symbol.Name}}({{field.Attribute.Data?.AttributeClass?.Name}}) as valid.");
                    }
                    """);
            }
            else
            {
                builder.AppendLine(
                    $"{targetName} = serialization.{method}(node{i}, hookCtx, context, null{nullableString});");
            }

            builder.AppendLine("}");
            builder.AppendLine("}");

            if (field.Attribute is { IsDataFieldAttribute: true, Required: true })
            {
                if (field.Type.IsReferenceType && fieldTypeName.EndsWith("?"))
                    fieldTypeName = fieldTypeName.Substring(0, fieldTypeName.Length - 1);

                builder.AppendLine($$"""
                    else
                    {
                        throw new RequiredFieldNotMappedException(typeof({{fieldTypeName}}), "{{tagName}}", typeof({{definition.Type.ToDisplayString()}}));
                    }
                    """);
            }

            if (field.Attribute.ServerOnly)
                builder.AppendLine("}");
        }

        return builder.ToString();
    }

    private static string GetReadCompMethod(DataDefinition definition)
    {
        var inheritsComp = TypeSymbolHelper.Inherits(definition.Type, ComponentName);
        if (!inheritsComp)
        {
            if (!TypeSymbolHelper.ShittyTypeMatch(definition.Type, ComponentName)) return string.Empty;

            return """
                public virtual void ReadComp(
                    ref Component target,
                    MappingDataNode mappingDataNode,
                    ISerializationManager serialization,
                    SerializationHookContext hookCtx,
                    ISerializationContext? context)
                {
                    Component.Read(ref target, mappingDataNode, serialization, hookCtx, context);
                }
                """;
        }

        return $$"""
            public override void ReadComp(
                ref Component target,
                MappingDataNode mappingDataNode,
                ISerializationManager serialization,
                SerializationHookContext hookCtx,
                ISerializationContext? context)
            {
                var cast = ({{definition.GenericTypeName}}) target;
                {{definition.GenericTypeName}}.Read(ref cast, mappingDataNode, serialization, hookCtx, context);
                target = (Component) cast;
            }
            """;
    }

    private static string GetInstantiators(DataDefinition definition)
    {
        var builder = new StringBuilder();
        var modifiers = string.Empty;

        if (definition.GetFirstDataDefinitionBaseType() != null)
            modifiers = "override ";
        else if (IsVirtualClass(definition.Type))
            modifiers = "virtual ";

        if (definition.Type.IsAbstract)
        {
            // TODO make abstract once data definitions are forced to be partial
            builder.AppendLine($$"""
                /// <seealso cref="ISerializationManager.CreateCopy"/>
                [Obsolete("Use ISerializationManager.CreateCopy instead")]
                public {{modifiers}} {{definition.GenericTypeName}} Instantiate()
                {
                    throw new NotImplementedException();
                }
                """);
        }
        else
        {
            var requiredFields = GetRequiredFieldsPropertiesAssigners(definition.Type, string.Empty);
            builder.AppendLine($$"""
                /// <seealso cref="ISerializationManager.CreateCopy"/>
                [Obsolete("Use ISerializationManager.CreateCopy instead")]
                public {{modifiers}} {{definition.GenericTypeName}} Instantiate()
                {
                    return new {{definition.GenericTypeName}}(){{requiredFields}};
                }

                public static {{definition.GenericTypeName}} StaticInstantiate()
                {
                    return new {{definition.GenericTypeName}}();
                }

                public static object StaticInstantiateObject()
                {
                    return (object) global::{{definition.Type.ToDisplayString()}}.StaticInstantiate();
                }
                """);
        }

        return builder.ToString();
    }

    private static string GetValidator(DataDefinition definition)
    {
        var builder = new StringBuilder();
        var validateBuilder = new StringBuilder();

        for (var i = 0; i < definition.Fields.Count; i++)
        {
            validateBuilder.Clear();

            var field = definition.Fields[i];
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            var fieldTypeName = GetNonNullableNameForGenericParameter(field.Type);
            var tagName = field.Attribute.Tag;
            if (field.Attribute.Include)
            {
                builder.AppendLine($"var node{i} = node;");
            }
            else
            {
                builder.AppendLine($$"""
                    if (node.TryGetValue("{{tagName}}", out var node{{i}}))
                    {
                    """);
            }

            var validator = field.CustomSerializer;
            var validatorName = validator?.Serializer.ToDisplayString();
            if (validator != null && (validator.Value.Type & MappingValidator) != 0)
            {
                validateBuilder.AppendLine($"""
                    case MappingDataNode mapping:
                        nodes["{tagName}"] = serialization.ValidateNode<{fieldTypeName}, MappingDataNode, {validatorName}>(mapping, context);
                        break;
                    """);
            }

            if (validator != null && (validator.Value.Type & SequenceValidator) != 0)
            {
                validateBuilder.AppendLine($"""
                    case SequenceDataNode sequence:
                        nodes["{tagName}"] = serialization.ValidateNode<{fieldTypeName}, SequenceDataNode, {validatorName}>(sequence, context);
                        break;
                    """);
            }

            if (validator != null && (validator.Value.Type & ValueValidator) != 0)
            {
                validateBuilder.AppendLine($"""
                    case ValueDataNode value:
                        nodes["{tagName}"] = serialization.ValidateNode<{fieldTypeName}, ValueDataNode, {validatorName}>(value, context);
                        break;
                    """);
            }

            builder.AppendLine($$"""
                switch (node{{i}})
                {
                    {{validateBuilder}}
                    default:
                        nodes["{{tagName}}"] = serialization.ValidateNode<{{fieldTypeName}}>(node{{i}}, context);
                        break;
                }
                """);

            if (!field.Attribute.Include)
                builder.AppendLine("}");
        }

        if (definition.GetFirstDataDefinitionBaseType() is { } baseType)
            builder.AppendLine($"{baseType.ToDisplayString()}.Validate(nodes, node, serialization, context);");

        return $$"""
            public static void Validate(Dictionary<string, ValidationNode> nodes, MappingDataNode node, ISerializationManager serialization, ISerializationContext? context = null)
            {
                {{builder}}
            }
            """;
    }

    private static string GetCopiers(DataDefinition definition)
    {
        var builder = new StringBuilder();
        var requiredFields = GetRequiredFieldsPropertiesAssigners(definition.Type, string.Empty);
        var type = definition.Type;
        var baseType = type.BaseType;
        var baseDefinition = false;
        while (baseType != null)
        {
            if (!baseDefinition && definition.IsDataDefinition(baseType, out _))
                baseDefinition = true;

            GetCopierMethod(definition, baseType, baseType.ToDisplayString(), true, builder, requiredFields);
            baseType = baseType.BaseType;
        }

        GetCopierMethod(definition, definition.Type, "object", baseDefinition, builder, requiredFields);
        GetCopierMethod(definition, definition.Type, GetGenericTypeName(type), false, builder, requiredFields);
        return builder.ToString();
    }

    private static void GetCopierMethod(
        DataDefinition definition,
        ITypeSymbol type,
        string targetType,
        bool forceOverride,
        StringBuilder builder,
        string requiredFields)
    {
        if (!definition.IsDataDefinition(type, out _))
            return;

        var isAbstract = definition.Type.IsAbstract;
        var modifier = GetModifier(definition, type, targetType, forceOverride, out var sameType);

        builder.AppendLine($"""
            public {modifier}void Copy(
                ref {targetType} target,
                ISerializationManager serialization,
                SerializationHookContext hookCtx,
                ISerializationContext? context = null)
            """);

        if (!sameType)
        {
            builder.AppendLine($$"""
                {
                    var def = ({{definition.GenericTypeName}})target;
                    Copy(ref def, serialization, hookCtx, context);
                    target = def;
                }
                """);
        }
        else if (!definition.Type.IsAbstract && (definition.Type.IsValueType || definition.IsRecord))
        {
            builder.AppendLine($$"""
                {
                    target = new {{definition.GenericTypeName}}(
                        ISerializationGeneratedCopy.Default,
                        this,
                        serialization,
                        hookCtx,
                        context
                    ){{requiredFields}};
                }
                """);
        }
        else
        {
            var baseCopy = definition.IsDataDefinition(definition.Type.BaseType, out _)
                ? $$"""
                      var definitionCast = ({{definition.Type.BaseType!.ToDisplayString()}})target;
                      base.Copy(ref definitionCast, serialization, hookCtx, context);
                      target = ({{definition.GenericTypeName}})definitionCast;
                  """
                : string.Empty;


            var instantiate = isAbstract
                ? $$"""
                      if (target is null)
                          throw new NullReferenceException("Cannot copy into a null abstract data definition target.");
                  """
                : $$"""
                      if (target is null)
                      {
                          target = new {{definition.GenericTypeName}}(
                              ISerializationGeneratedCopy.Default,
                              this,
                              serialization,
                              hookCtx,
                              context
                          ){{requiredFields}};
                          return;
                      }
                  """;

            builder.AppendLine($$"""
                {
                    {{instantiate}}
                    var source = this;
                    {{baseCopy}}
                    if (serialization.TryCustomCopy(this, ref target, hookCtx, {{definition.HasHooks.ToString().ToLower()}}, context))
                        return;

                    {{GetCopyBody(definition, "target")}}
                }
                """);
        }
    }

    private static object GetModifier(
        DataDefinition definition,
        ITypeSymbol type,
        string targetType,
        bool forceOverride,
        out bool sameType)
    {
        sameType = definition.Type.Equals(type, SymbolEqualityComparer.Default) &&
                       targetType == definition.GenericTypeName &&
                       targetType != "object";
        var isSealedOrStruct = definition.Type.IsSealed || definition.Type.IsValueType;
        var isInterface = definition.Type.TypeKind == TypeKind.Interface;
        var modifier = (sameType, targetType == "object", isSealedOrStruct, isInterface) switch
        {
            (true, _, true, _) => string.Empty,
            (true, _, false, _) => "virtual ",
            (false, true, true, _) => string.Empty,
            (false, true, false, _) => "virtual ",
            (false, false, _, true) => string.Empty,
            (false, false, _, false) => "override ",
        };

        if (!sameType && targetType == "object" && forceOverride)
            modifier = "override ";

        if (forceOverride && modifier is "" or "virtual ")
        {
            if (modifier is "")
                modifier += "override ";
            else if (modifier == "virtual ")
                modifier = "override ";
        }

        return modifier;
    }

    private static string GetReaders(DataDefinition definition)
    {
        string body;
        if (definition.Type.IsAbstract)
        {
            var baseRead = definition.IsDataDefinition(definition.Type.BaseType, out _)
                ? $$"""
                      var definitionCast = ({{definition.Type.BaseType!.ToDisplayString()}})target;
                      {{definition.Type.BaseType!.ToDisplayString()}}.Read(ref definitionCast, mappingDataNode, serialization, hookCtx, context);
                      target = ({{definition.GenericTypeName}})definitionCast;
                  """
                : string.Empty;

            body = $$"""
                if (target is null)
                    throw new NullReferenceException("Cannot read into a null abstract data definition target.");

                {{baseRead}}
                {{GetReadBody(definition, "target")}}
                """;
        }
        else if (definition.Type.IsValueType || definition.IsRecord)
        {
            body = $$"""
                target = new {{definition.GenericTypeName}}(
                    ISerializationGeneratedRead.Default,
                    mappingDataNode,
                    serialization,
                    hookCtx,
                    context
                );
                """;
        }
        else
        {
            var baseRead = definition.IsDataDefinition(definition.Type.BaseType, out _)
                ? $$"""
                      var definitionCast = ({{definition.Type.BaseType!.ToDisplayString()}})target;
                      {{definition.Type.BaseType!.ToDisplayString()}}.Read(ref definitionCast, mappingDataNode, serialization, hookCtx, context);
                      target = ({{definition.GenericTypeName}})definitionCast;
                  """
                : string.Empty;

            body = $$"""
                if (target is null)
                {
                    target = new {{definition.GenericTypeName}}(
                        ISerializationGeneratedRead.Default,
                        mappingDataNode,
                        serialization,
                        hookCtx,
                        context
                    );
                    return;
                }

                {{baseRead}}
                {{GetReadBody(definition, "target")}}
                """;
        }

        return $$"""
            public static void Read(
                ref {{definition.GenericTypeName}} target,
                MappingDataNode mappingDataNode,
                ISerializationManager serialization,
                SerializationHookContext hookCtx,
                ISerializationContext? context)
            {
                {{body}}
            }

            {{GetReadCompMethod(definition)}}
            """;
    }

    private static string GetWriter(DataDefinition definition)
    {
        var builder = new StringBuilder();
        for (var i = 0; i < definition.Fields.Count; i++)
        {
            var field = definition.Fields[i];
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            if (field.Attribute.ReadOnly)
                continue;

            var fieldType = field.Type.ToDisplayString();
            if (IsMultidimensionalArray(field.Type))
                fieldType = fieldType.Replace("*", "");

            if (field.Type.NullableAnnotation == NullableAnnotation.Annotated &&
                !fieldType.EndsWith("?"))
            {
                fieldType += "?";
            }

            var nonNullableFieldType = GetNonNullableNameForGenericParameter(field.Type);
            var nullable = fieldType.EndsWith("?");
            var nullableString = string.Empty;
            if (!field.Type.IsValueType)
            {
                if (!nullable)
                    nullableString = ", true";

                if (nonNullableFieldType.EndsWith("?"))
                    nonNullableFieldType = nonNullableFieldType.Substring(0, nonNullableFieldType.Length - 1);
            }

            if (field.Attribute.ServerOnly)
            {
                builder.AppendLine("""
                    if (serialization.IsServer)
                    {
                    """);
            }

            if (!field.Attribute.IsDataFieldAttribute || !field.Attribute.Required)
            {
                builder.AppendLine($$"""
                    if (alwaysWrite || !EqualityComparer<{{fieldType}}>.Default.Equals(obj.{{field.Symbol.Name}}, ({{fieldType}}) defaultValues["{{field.Attribute.Tag}}"]!))
                    {
                    """);
            }

            builder.AppendLine($"""DataNode node{i};""");

            if (field.Attribute.IsDataFieldAttribute)
            {
                builder.AppendLine($$"""
                    if (!mapping.Has("{{field.Attribute.Tag}}"))
                    {
                    """);
            }

            if (field.CustomSerializer is { } serializer &&
                (serializer.Type & Writer) != 0)
            {
                var nullableValueType = field.Type.IsValueType && nullable;
                if (nullableValueType)
                {
                    builder.AppendLine($$"""
                        if (obj.{{field.Symbol.Name}} == null)
                        {
                            node{{i}} = ValueDataNode.Null();
                        }
                        else
                        {
                        """);
                }

                var nullableValueTypeString = nullableValueType ? ".Value" : string.Empty;
                var writerName = serializer.Serializer.ToDisplayString();
                builder.AppendLine($"""
                    #pragma warning disable RA0008
                    node{i} = serialization.WriteValue<{nonNullableFieldType}, {writerName}>(obj.{field.Symbol.Name}{nullableValueTypeString}!, alwaysWrite, context{nullableString});
                    #pragma warning restore RA0008
                    """);

                if (nullableValueType)
                    builder.Append("}");
            }
            else
            {
                builder.AppendLine(
                    $"node{i} = serialization.WriteValue<{fieldType}>(obj.{field.Symbol.Name}, alwaysWrite, context{nullableString});");
            }

            if (field.Attribute.IsDataFieldAttribute)
            {
                builder.AppendLine($$"""
                        mapping.Add("{{field.Attribute.Tag}}", node{{i}});
                    }
                    """);
            }
            else
            {
                builder.AppendLine($$"""
                        if (node{{i}} is MappingDataNode mapping{{i}})
                        {
                            mapping.Insert(mapping{{i}}, true);
                        }
                        else
                        {
                            throw new InvalidOperationException($"Writing field {{field.Symbol.Name}} for type {typeof({{definition.GenericTypeName}})} did not return a {nameof(MappingDataNode)} but was annotated to be included.");
                        }
                    """);
            }

            if (!field.Attribute.IsDataFieldAttribute || !field.Attribute.Required)
                builder.AppendLine("}");

            if (field.Attribute.ServerOnly)
                builder.AppendLine("}");

        }

        if (definition.GetFirstDataDefinitionBaseType() is { } baseType)
        {
            var baseTypeName = baseType.ToDisplayString();
            builder.AppendLine(
                $"{baseTypeName}.Write(obj, mapping, serialization, context, alwaysWrite, defaultValues);");
        }

        return $$"""
            public static void Write(
                {{definition.GenericTypeName}} obj,
                MappingDataNode mapping,
                ISerializationManager serialization,
                ISerializationContext? context,
                bool alwaysWrite,
                ImmutableDictionary<string, object?> defaultValues)
            {
                {{builder}}
            }
            """;
    }

    private static string GetEquality(DataDefinition definition)
    {
        var builder = new StringBuilder();

        if (definition.GetFirstDataDefinitionBaseType() is { } baseType)
        {
            builder.AppendLine($$"""
                if (!{{baseType.ToDisplayString()}}.AreEqual(left, right, serialization, context))
                    return false;
                """);
        }

        foreach (var field in definition.Fields)
        {
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            if (field.Attribute.ReadOnly)
                continue;

            var fieldType = field.Type.ToDisplayString();
            if (IsMultidimensionalArray(field.Type))
                fieldType = fieldType.Replace("*", "");

            if (field.Type.NullableAnnotation == NullableAnnotation.Annotated &&
                !fieldType.EndsWith("?"))
            {
                fieldType += "?";
            }

            var equalityExpression = GetFieldEqualityExpression(field, fieldType);

            builder.AppendLine($$"""
                if (!{{equalityExpression}})
                    return false;
                """);
        }

        builder.AppendLine("return true;");

        return $$"""
            public static bool AreEqual(
                {{definition.GenericTypeName}} left,
                {{definition.GenericTypeName}} right,
                ISerializationManager serialization,
                ISerializationContext? context = null)
            {
                {{builder}}
            }
            """;
    }

    private static string GetFieldEqualityExpression(DataField field, string fieldType)
    {
        var fieldName = field.Symbol.Name;

        if (TryGetFastHashSetEquality(field.Type, $"left.{fieldName}", $"right.{fieldName}", out var hashSetEquality))
            return hashSetEquality;

        if (CanFieldUseDirectEquality(field))
            return $"EqualityComparer<{fieldType}>.Default.Equals(left.{fieldName}, right.{fieldName})";

        return $"serialization.DataFieldEquals<{fieldType}>(left.{fieldName}, right.{fieldName}, context)";
    }

    private static bool CanFieldUseDirectEquality(DataField field)
    {
        return CanTypeBeCopiedByValue(field.Type);
    }

    private static bool TryGetFastHashSetEquality(
        ITypeSymbol type,
        string leftAccess,
        string rightAccess,
        [NotNullWhen(true)] out string? equality)
    {
        equality = null;

        if (type.WithNullableAnnotation(NullableAnnotation.None) is not INamedTypeSymbol namedType ||
            !IsGenericCollectionType(namedType, "HashSet", 1))
        {
            return false;
        }

        equality =
            $"ReferenceEquals({leftAccess}, {rightAccess}) || ({leftAccess} != null && {rightAccess} != null && {leftAccess}.SetEquals({rightAccess}))";
        return true;
    }

    private static string GetFieldDefinitions(DataDefinition definition)
    {
        var builder = new StringBuilder();
        var nullConditional = definition.Type.IsValueType ? string.Empty : "?";
        var fieldTags = new List<string>(definition.Fields.Count);
        foreach (var field in definition.Fields)
        {
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            var (fieldType, _) = GetCleanNameForGenericType(field.Type, out var isNullableValueType);
            var nullable = field.Type.NullableAnnotation == NullableAnnotation.Annotated ||
                           field.Type.ToDisplayString().EndsWith("?");

            if (!isNullableValueType && fieldType.EndsWith("?"))
                fieldType = fieldType.Substring(0, fieldType.Length - 1);

            builder.AppendLine($$"""
                if (fieldsParsed == null || !fieldsParsed.Contains("{{field.Attribute.Tag}}"))
                {
                    fields.Add(new DataFieldDefinition(
                        "{{field.Attribute.Tag}}",
                        {{field.Attribute.Priority}},
                        {{field.Attribute.IsDataFieldAttribute.ToString().ToLowerInvariant()}},
                        {{field.Attribute.Include.ToString().ToLowerInvariant()}},
                        instance{{nullConditional}}.{{field.Symbol.Name}},
                        (InheritanceBehavior) {{field.Attribute.InheritanceBehavior}},
                        "{{field.Symbol.Name}}",
                        typeof({{fieldType}}),
                        {{nullable.ToString().ToLowerInvariant()}},
                        "{{field.Attribute.CamelCasedName}}",
                        {{(field.CustomSerializer == null ? "null" : $"typeof({field.CustomSerializer.Value.Serializer.ToDisplayString()})")}}
                    ));
                }
                """);

            fieldTags.Add($"\"{field.Attribute.Tag}\"");
        }

        if (definition.GetFirstDataDefinitionBaseType() is { } baseType)
            builder.AppendLine(
                $"{baseType.ToDisplayString()}.GetFieldDefinitions(instance, fields, [{string.Join(", ", fieldTags)}]);");

        var instance = definition.Type.IsAbstract
            ? string.Empty
            : $"instance = global::{definition.Type.ToDisplayString()}.StaticInstantiate();";

        return $$"""
            public static void GetFieldDefinitions({{definition.GenericTypeName}}{{nullConditional}} instance, List<DataFieldDefinition> fields, string[]? fieldsParsed = null)
            {
                {{instance}}
                {{builder}}
            }
            """;
    }

    // TODO serveronly? do we care? who knows!!
    private static StringBuilder GetCopyBody(DataDefinition definition, string targetPrefix = "")
    {
        var builder = new StringBuilder();
        foreach (var field in definition.Fields)
        {
            if (!definition.Type.Equals(field.Symbol.ContainingType, SymbolEqualityComparer.Default))
                continue;

            var type = field.Type;
            var (typeName, nonNullableTypeName) = GetCleanNameForGenericType(type, out var isNullableValueType);

            var isClass = type.IsReferenceType || type.SpecialType == SpecialType.System_String;
            var isNullable = type.NullableAnnotation == NullableAnnotation.Annotated ||
                             field.Type.ToDisplayString().EndsWith("?");
            var nullableOverride = isClass && !isNullable ? ", true" : string.Empty;
            var name = field.Symbol.Name;
            var targetName = string.IsNullOrEmpty(targetPrefix) ? name : $"{targetPrefix}.{name}";
            var nullableValue = isNullableValueType ? ".Value" : string.Empty;
            var nullNotAllowed = isClass && !isNullable;

            if (field.CustomSerializer is { Serializer: var serializer, Type: var serializerType } &&
                ((serializerType & Copier) != 0 || (serializerType & CopyCreator) != 0))
            {
                if (nullNotAllowed)
                {
                    builder.AppendLine($$"""
                        if (source.{{name}} == null)
                        {
                            throw new NullNotAllowedException();
                        }
                        """);
                }

                if (isNullable || isNullableValueType)
                {
                    builder.AppendLine($$"""
                        if (source.{{name}} == null)
                        {
                            {{targetName}} = null!;
                        }
                        else
                        {
                        """);
                }

                var serializerName = serializer.ToDisplayString();

                // TODO ROBUST should these both be created if both are present?
                if ((serializerType & Copier) != 0)
                {
                    builder.AppendLine($"""
                        #pragma warning disable RA0008
                        {nonNullableTypeName} {name}GeneratedTemp = default!;
                        serialization.CopyTo<{nonNullableTypeName}, {serializerName}>(source.{name}{nullableValue}, ref {name}GeneratedTemp, hookCtx, context{nullableOverride});
                        #pragma warning restore RA0008
                        {targetName} = {name}GeneratedTemp;
                        """);
                }
                else if ((serializerType & CopyCreator) != 0)
                {
                    builder.AppendLine(
                        $"{targetName} = serialization.CreateCopy<{nonNullableTypeName}, {serializerName}>(source.{name}{nullableValue}, hookCtx, context{nullableOverride});");
                }

                if (isNullable || isNullableValueType)
                    builder.AppendLine("}");
            }
            else if (CanBeCopiedByValue(field.Symbol, field.Type))
            {
                if (nullNotAllowed)
                {
                    builder.AppendLine($$"""
                        if (source.{{name}} == null)
                        {
                            throw new NullNotAllowedException();
                        }
                        """);
                }

                builder.AppendLine($"{targetName} = source.{name};");
            }
            else
            {
                if (nullNotAllowed)
                {
                    builder.AppendLine($$"""
                        if (source.{{name}} == null)
                        {
                            throw new NullNotAllowedException();
                        }
                        """);
                }

                if (TryGetFastCollectionCopy(field.Type, $"source.{name}", targetName, isNullable, out var collectionCopy))
                {
                    builder.Append(collectionCopy);
                }
                else
                {
                    var hasHooks = ImplementsInterface(type, SerializationHooksNamespace) || !type.IsSealed;
                    builder.AppendLine($$"""
                        {{typeName}} {{name}}GeneratedTemp = default!;
                        if (serialization.TryCustomCopy(source.{{name}}, ref {{name}}GeneratedTemp, hookCtx, {{hasHooks.ToString().ToLower()}}, context))
                        {
                            {{targetName}} = {{name}}GeneratedTemp;
                        }
                        else
                        {
                        """);

                    if (definition.IsDataDefinition(type, out _) && !type.IsAbstract &&
                        type is not INamedTypeSymbol { TypeKind: TypeKind.Interface })
                    {
                        var nullable = !type.IsValueType || IsNullableType(type);

                        if (nullable)
                        {
                            builder.AppendLine($$"""
                                if (source.{{name}} == null)
                                {
                                    {{targetName}} = null!;
                                }
                                else
                                {
                                """);
                        }

                        builder.AppendLine($"""
                            serialization.CopyTo(source.{name}, ref {name}GeneratedTemp, hookCtx, context{nullableOverride});
                            {targetName} = {name}GeneratedTemp;
                            """);

                        if (nullable)
                            builder.AppendLine("}");
                    }
                    else
                    {
                        builder.AppendLine($"{targetName} = serialization.CreateCopy(source.{name}, hookCtx, context);");
                    }

                    builder.AppendLine("}");
                }
            }
        }

        return builder;
    }

    private static bool TryGetFastCollectionCopy(
        ITypeSymbol type,
        string sourceName,
        string targetName,
        bool nullable,
        [NotNullWhen(true)] out string? copy)
    {
        copy = null;
        var builder = new StringBuilder();
        var nullPrefix = string.Empty;
        var nullSuffix = string.Empty;

        if (!type.IsValueType)
        {
            if (nullable)
            {
                nullPrefix = $$"""
                    if ({{sourceName}} == null)
                    {
                        {{targetName}} = null!;
                    }
                    else
                    {
                    """;
                nullSuffix = "}\n";
            }
        }

        var sourceAccess = nullable ? $"{sourceName}!" : sourceName;

        if (type is IArrayTypeSymbol { Rank: 1 } arrayType &&
            CanTypeBeCopiedByValue(arrayType.ElementType))
        {
            var arrayTypeName = type.WithNullableAnnotation(NullableAnnotation.None).ToDisplayString();
            builder.Append(nullPrefix);
            builder.AppendLine($"{targetName} = ({arrayTypeName}) {sourceAccess}.Clone();");
            builder.Append(nullSuffix);
            copy = builder.ToString();
            return true;
        }

        if (type is not INamedTypeSymbol { IsGenericType: true } namedType)
            return false;

        var nonNullableTypeName = type.WithNullableAnnotation(NullableAnnotation.None).ToDisplayString();
        var typeArgs = namedType.TypeArguments;
        var targetAccess = $"{targetName}!";

        if (IsGenericCollectionType(namedType, "List", 1) &&
            CanTypeBeCopiedByValue(typeArgs[0]))
        {
            builder.Append(nullPrefix);
            builder.AppendLine($$"""
                if ({{targetName}} == null)
                    {{targetName}} = new {{nonNullableTypeName}}({{sourceAccess}}.Count);
                else
                {
                    {{targetAccess}}.Clear();
                    {{targetAccess}}.EnsureCapacity({{sourceAccess}}.Count);
                }

                {{targetAccess}}.AddRange({{sourceAccess}});
                """);
            builder.Append(nullSuffix);
            copy = builder.ToString();
            return true;
        }

        if (IsGenericCollectionType(namedType, "HashSet", 1) &&
            CanTypeBeCopiedByValue(typeArgs[0]))
        {
            builder.Append(nullPrefix);
            builder.AppendLine($$"""
                if ({{targetName}} == null)
                    {{targetName}} = new {{nonNullableTypeName}}({{sourceAccess}}.Count, {{sourceAccess}}.Comparer);
                else
                {
                    {{targetAccess}}.Clear();
                    {{targetAccess}}.EnsureCapacity({{sourceAccess}}.Count);
                }

                foreach (var value in {{sourceAccess}})
                    {{targetAccess}}.Add(value);
                """);
            builder.Append(nullSuffix);
            copy = builder.ToString();
            return true;
        }

        if (IsGenericCollectionType(namedType, "Dictionary", 2) &&
            CanTypeBeCopiedByValue(typeArgs[0]) &&
            CanTypeBeCopiedByValue(typeArgs[1]))
        {
            builder.Append(nullPrefix);
            builder.AppendLine($$"""
                if ({{targetName}} == null)
                    {{targetName}} = new {{nonNullableTypeName}}({{sourceAccess}}.Count, {{sourceAccess}}.Comparer);
                else
                {
                    {{targetAccess}}.Clear();
                    {{targetAccess}}.EnsureCapacity({{sourceAccess}}.Count);
                }

                foreach (var (key, value) in {{sourceAccess}})
                    {{targetAccess}}.Add(key, value);
                """);
            builder.Append(nullSuffix);
            copy = builder.ToString();
            return true;
        }

        if (IsGenericCollectionType(namedType, "SortedDictionary", 2) &&
            CanTypeBeCopiedByValue(typeArgs[0]) &&
            CanTypeBeCopiedByValue(typeArgs[1]))
        {
            builder.Append(nullPrefix);
            builder.AppendLine($$"""
                if ({{targetName}} == null)
                    {{targetName}} = new {{nonNullableTypeName}}({{sourceAccess}}.Comparer);
                else
                    {{targetAccess}}.Clear();

                foreach (var (key, value) in {{sourceAccess}})
                    {{targetAccess}}.Add(key, value);
                """);
            builder.Append(nullSuffix);
            copy = builder.ToString();
            return true;
        }

        return false;
    }

    private static bool IsGenericCollectionType(INamedTypeSymbol type, string name, int typeArgumentCount)
    {
        var definition = type.ConstructedFrom;

        return definition.Name == name &&
               definition.TypeArguments.Length == typeArgumentCount &&
               definition.ContainingNamespace.ToDisplayString() == "System.Collections.Generic";
    }
}