PropertyDefinitionsExtractor.cs

Go to the documentation of this file.

//-----------------------------------------------------------------------
// <copyright file="PropertyDefinitionsExtractor.cs" company="Marimer LLC">
//     Copyright (c) Marimer LLC. All rights reserved.
//     Website: https://cslanet.com
// </copyright>
// <summary>Extract the definitions of all properties of a type for source generation</summary>
//-----------------------------------------------------------------------
using Csla.Serialization;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
 
namespace Csla.Generators.CSharp.AutoSerialization.Discovery
{
 
  internal static class PropertyDefinitionsExtractor
  {
 
    public static IReadOnlyList<ExtractedPropertyDefinition> ExtractPropertyDefinitions(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<ExtractedPropertyDefinition> propertyDefinitions = new List<ExtractedPropertyDefinition>();
      ExtractedPropertyDefinition propertyDefinition;
      IReadOnlyList<PropertyDeclarationSyntax> serializableProperties;
 
      serializableProperties = GetSerializablePropertyDeclarations(extractionContext, targetTypeDeclaration);
      foreach (PropertyDeclarationSyntax propertyDeclaration in serializableProperties)
      {
        propertyDefinition = PropertyDefinitionExtractor.ExtractPropertyDefinition(extractionContext, propertyDeclaration);
        propertyDefinitions.Add(propertyDefinition);
      }
 
      return propertyDefinitions;
    }
 
    #region Private Helper Methods
 
    private static IReadOnlyList<PropertyDeclarationSyntax> GetSerializablePropertyDeclarations(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<PropertyDeclarationSyntax> serializableProperties;
      List<PropertyDeclarationSyntax> optedInSerializableProperties;
 
      // Get public or internal properties that are not specifically opted out with the [AutoNonSerialized] attribute
      serializableProperties = GetPublicNonExcludedProperties(extractionContext, targetTypeDeclaration);
 
      // Add any private or protected properties that are opted in with the use of the [AutoSerialized] attribute
      optedInSerializableProperties = GetNonPublicIncludedProperties(extractionContext, targetTypeDeclaration);
      serializableProperties.AddRange(optedInSerializableProperties);
 
      return serializableProperties;
    }
 
    private static List<PropertyDeclarationSyntax> GetPublicNonExcludedProperties(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<PropertyDeclarationSyntax> serializableProperties;
 
      // Get public or internal properties that are not specifically opted out with the [AutoNonSerialized] attribute
      serializableProperties = targetTypeDeclaration.Members.Where(
        m => m is PropertyDeclarationSyntax propertyDeclaration &&
        HasOneOfScopes(extractionContext, propertyDeclaration, "public") &&
        HasGetterAndSetter(extractionContext, propertyDeclaration) &&
        !extractionContext.IsPropertyDecoratedWithAutoNonSerialized(propertyDeclaration))
        .Cast<PropertyDeclarationSyntax>()
        .ToList();
 
      return serializableProperties;
    }
 
    private static List<PropertyDeclarationSyntax> GetNonPublicIncludedProperties(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<PropertyDeclarationSyntax> serializableProperties;
 
      // Get private or protected properties that are specifically opted in with the [AutoSerialized] attribute
      serializableProperties = targetTypeDeclaration.Members.Where(
        m => m is PropertyDeclarationSyntax propertyDeclaration &&
        !HasOneOfScopes(extractionContext, propertyDeclaration, "public") &&
        HasGetterAndSetter(extractionContext, propertyDeclaration) &&
        extractionContext.IsPropertyDecoratedWithAutoSerialized(propertyDeclaration))
        .Cast<PropertyDeclarationSyntax>()
        .ToList();
 
      return serializableProperties;
    }
 
    private static bool HasOneOfScopes(DefinitionExtractionContext context, PropertyDeclarationSyntax propertyDeclaration, params string[] scopes)
    {
      foreach (string scope in scopes)
      {
        if (propertyDeclaration.Modifiers.Any(m => m.ValueText.Equals(scope, StringComparison.InvariantCultureIgnoreCase)))
        {
          return true;
        }
      }
 
      return false;
    }
 
    private static bool HasGetterAndSetter(DefinitionExtractionContext context, PropertyDeclarationSyntax propertyDeclaration)
    {
      bool hasGetter = false;
      bool hasSetter = false;
 
      if (propertyDeclaration.AccessorList is null) return false;
 
      foreach (AccessorDeclarationSyntax accessorDeclaration in propertyDeclaration.AccessorList.Accessors)
      {
        if (accessorDeclaration.Kind() == Microsoft.CodeAnalysis.CSharp.SyntaxKind.GetAccessorDeclaration)
        {
          hasGetter = true;
        }
        if (accessorDeclaration.Kind() == Microsoft.CodeAnalysis.CSharp.SyntaxKind.SetAccessorDeclaration)
        {
          hasSetter = true;
        }
      }
 
      return hasGetter && hasSetter;
    }
 
    #endregion
 
  }
}