FieldDefinitionsExtractor.cs

Go to the documentation of this file.

//-----------------------------------------------------------------------
// <copyright file="FieldDefinitionsExtractor.cs" company="Marimer LLC">
//     Copyright (c) Marimer LLC. All rights reserved.
//     Website: https://cslanet.com
// </copyright>
// <summary>Extract the definitions of all fields for source generation</summary>
//-----------------------------------------------------------------------
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 FieldDefinitionsExtractor
  {
 
    public static IReadOnlyList<ExtractedFieldDefinition> ExtractFieldDefinitions(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<ExtractedFieldDefinition> propertyDefinitions = new List<ExtractedFieldDefinition>();
      ExtractedFieldDefinition fieldDefinition;
      IReadOnlyList<FieldDeclarationSyntax> serializableFields;
 
      serializableFields = GetSerializableFieldDeclarations(extractionContext, targetTypeDeclaration);
      foreach (FieldDeclarationSyntax fieldDeclaration in serializableFields)
      {
        fieldDefinition = FieldDefinitionExtractor.ExtractFieldDefinition(extractionContext, fieldDeclaration);
        propertyDefinitions.Add(fieldDefinition);
      }
 
      return propertyDefinitions;
    }
 
    #region Private Helper Methods
 
    private static IReadOnlyList<FieldDeclarationSyntax> GetSerializableFieldDeclarations(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<FieldDeclarationSyntax> serializableFields;
      List<FieldDeclarationSyntax> optedInSerializableFields;
 
      // Get all fields that are not specifically opted out with the [AutoNonSerialized] attribute
      serializableFields = GetPublicNonExcludedFields(extractionContext, targetTypeDeclaration);
 
      // Add any pfields that are opted in with the use of the [AutoSerialized] attribute
      optedInSerializableFields = GetNonPublicIncludedFields(extractionContext, targetTypeDeclaration);
      serializableFields.AddRange(optedInSerializableFields);
      // serializableFields = GetAllIncludedFields(extractionContext, targetTypeDeclaration);
 
      return serializableFields;
    }
 
    private static List<FieldDeclarationSyntax> GetPublicNonExcludedFields(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<FieldDeclarationSyntax> serializableFields;
 
      // Get all fields that are not specifically opted out with the [AutoNonSerialized] attribute
      serializableFields = targetTypeDeclaration.Members.Where(
        m => m is FieldDeclarationSyntax fieldDeclaration &&
        HasOneOfScopes(extractionContext, fieldDeclaration, "public") &&
        !extractionContext.IsFieldDecoratedWithAutoNonSerialized(fieldDeclaration))
        .Cast<FieldDeclarationSyntax>()
        .ToList();
 
      return serializableFields;
    }
 
    private static List<FieldDeclarationSyntax> GetNonPublicIncludedFields(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<FieldDeclarationSyntax> serializableFields;
 
      // Get any private or protected fields that are opted in with the use of the [AutoSerialized] attribute
      serializableFields = targetTypeDeclaration.Members.Where(
        m => m is FieldDeclarationSyntax fieldDeclaration &&
        !HasOneOfScopes(extractionContext, fieldDeclaration, "public") &&
        extractionContext.IsFieldDecoratedWithAutoSerialized(fieldDeclaration))
        .Cast<FieldDeclarationSyntax>()
        .ToList();
 
      return serializableFields;
    }
 
    private static List<FieldDeclarationSyntax> GetAllIncludedFields(DefinitionExtractionContext extractionContext, TypeDeclarationSyntax targetTypeDeclaration)
    {
      List<FieldDeclarationSyntax> serializableFields;
 
      // Get any private or protected fields that are opted in with the use of the [AutoSerialized] attribute
      serializableFields = targetTypeDeclaration.Members.Where(
        m => m is FieldDeclarationSyntax fieldDeclaration &&
        extractionContext.IsFieldDecoratedWithAutoSerialized(fieldDeclaration))
        .Cast<FieldDeclarationSyntax>()
        .ToList();
 
      return serializableFields;
    }
 
    private static bool HasOneOfScopes(DefinitionExtractionContext context, FieldDeclarationSyntax fieldDeclaration, params string[] scopes)
    {
      foreach (string scope in scopes)
      {
        if (fieldDeclaration.Modifiers.Any(m => m.ValueText.Equals(scope, StringComparison.InvariantCultureIgnoreCase)))
        {
          return true;
        }
      }
 
      return false;
    }
 
    #endregion
 
  }
}