// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Collections.Immutable;
using Analyzer.Utilities;
using Analyzer.Utilities.Extensions;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Diagnostics;

namespace Microsoft.CodeQuality.Analyzers.ApiDesignGuidelines
{
    using static MicrosoftCodeQualityAnalyzersResources;

    /// <summary>
    /// CA1002: <inheritdoc cref="DoNotExposeGenericListsTitle"/>
    /// </summary>
    [DiagnosticAnalyzer(LanguageNames.CSharp, LanguageNames.VisualBasic)]
    public sealed class DoNotExposeGenericLists : DiagnosticAnalyzer
    {
        internal const string RuleId = "CA1002";

        internal static readonly DiagnosticDescriptor Rule = DiagnosticDescriptorHelper.Create(
            RuleId,
            CreateLocalizableResourceString(nameof(DoNotExposeGenericListsTitle)),
            CreateLocalizableResourceString(nameof(DoNotExposeGenericListsMessage)),
            DiagnosticCategory.Design,
            RuleLevel.Disabled,
            description: CreateLocalizableResourceString(nameof(DoNotExposeGenericListsDescription)),
            isPortedFxCopRule: true,
            isDataflowRule: false);

        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; } = ImmutableArray.Create(Rule);

        public override void Initialize(AnalysisContext context)
        {
            context.EnableConcurrentExecution();
            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);

            context.RegisterCompilationStartAction(context =>
            {
                if (!context.Compilation.TryGetOrCreateTypeByMetadataName(WellKnownTypeNames.SystemCollectionsGenericList1, out var genericListType))
                {
                    return;
                }

                context.RegisterSymbolAction(context =>
                {
                    var field = (IFieldSymbol)context.Symbol;

                    // FxCop compat: only analyze externally visible symbols by default.
                    if (!context.Options.MatchesConfiguredVisibility(Rule, field, context.Compilation))
                    {
                        return;
                    }

                    if (field.Type != null && field.Type.OriginalDefinition.Equals(genericListType))
                    {
                        context.ReportDiagnostic(field.CreateDiagnostic(Rule,
                            field.Type.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat),
                            field.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat)));
                    }
                }, SymbolKind.Field);

                context.RegisterSymbolAction(context =>
                {
                    var property = (IPropertySymbol)context.Symbol;

                    if (property.IsOverride ||
                        property.IsImplementationOfAnyInterfaceMember())
                    {
                        return;
                    }

                    // FxCop compat: only analyze externally visible symbols by default.
                    if (!context.Options.MatchesConfiguredVisibility(Rule, property, context.Compilation))
                    {
                        return;
                    }

                    if (property.Type != null && property.Type.OriginalDefinition.Equals(genericListType))
                    {
                        context.ReportDiagnostic(property.CreateDiagnostic(Rule,
                            property.Type.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat),
                            property.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat)));
                    }
                }, SymbolKind.Property);

                context.RegisterSymbolAction(context =>
                {
                    var methodSymbol = (IMethodSymbol)context.Symbol;

                    // Bail-out for accessor
                    if (methodSymbol.AssociatedSymbol != null)
                    {
                        return;
                    }

                    if (methodSymbol.IsOverride ||
                        methodSymbol.IsImplementationOfAnyInterfaceMember())
                    {
                        return;
                    }

                    // FxCop compat: only analyze externally visible symbols by default.
                    if (!context.Options.MatchesConfiguredVisibility(Rule, methodSymbol, context.Compilation))
                    {
                        return;
                    }

                    // Handle symbol return type
                    if (methodSymbol.ReturnType != null && methodSymbol.ReturnType.OriginalDefinition.Equals(genericListType))
                    {
                        context.ReportDiagnostic(methodSymbol.CreateDiagnostic(Rule,
                            methodSymbol.ReturnType.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat),
                            methodSymbol.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat)));
                    }

                    // Handle symbol parameters
                    for (int i = 0; i < methodSymbol.Parameters.Length; i++)
                    {
                        var parameter = methodSymbol.Parameters[i];

                        if (parameter.Type != null && parameter.Type.OriginalDefinition.Equals(genericListType) &&
                            (i != 0 || !methodSymbol.IsExtensionMethod))
                        {
                            context.ReportDiagnostic(parameter.CreateDiagnostic(Rule,
                                parameter.Type.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat),
                                methodSymbol.ToDisplayString(SymbolDisplayFormats.ShortSymbolDisplayFormat)));
                        }
                    }
                }, SymbolKind.Method);
            });
        }
    }
}