// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System.Collections.Immutable;
using Microsoft.CodeAnalysis.CodeStyle;
using Microsoft.CodeAnalysis.Diagnostics;

namespace Microsoft.CodeAnalysis.CodeQuality;

internal abstract class AbstractCodeQualityDiagnosticAnalyzer : DiagnosticAnalyzer, IBuiltInAnalyzer
{
    private readonly GeneratedCodeAnalysisFlags _generatedCodeAnalysisFlags;

    protected AbstractCodeQualityDiagnosticAnalyzer(
        ImmutableArray<DiagnosticDescriptor> descriptors,
        GeneratedCodeAnalysisFlags generatedCodeAnalysisFlags)
    {
        SupportedDiagnostics = descriptors;
        _generatedCodeAnalysisFlags = generatedCodeAnalysisFlags;
    }

    public bool IsHighPriority => false;
    public sealed override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get; }

    public sealed override void Initialize(AnalysisContext context)
    {
        context.ConfigureGeneratedCodeAnalysis(_generatedCodeAnalysisFlags);
        context.EnableConcurrentExecution();

        InitializeWorker(context);
    }

    protected abstract void InitializeWorker(AnalysisContext context);

    public abstract DiagnosticAnalyzerCategory GetAnalyzerCategory();

    protected static DiagnosticDescriptor CreateDescriptor(
        string id,
        EnforceOnBuild enforceOnBuild,
        LocalizableString title,
        LocalizableString messageFormat,
        bool hasAnyCodeStyleOption,
        bool isUnnecessary,
        bool isEnabledByDefault = true,
        bool isConfigurable = true,
        LocalizableString? description = null,
        DiagnosticSeverity defaultSeverity = DiagnosticSeverity.Info,
        string? helpLinkUri = null)
#pragma warning disable RS0030 // Do not use banned APIs
        => new(
                id, title, messageFormat,
                DiagnosticCategory.CodeQuality,
                defaultSeverity,
                isEnabledByDefault,
                description,
                helpLinkUri: helpLinkUri ?? DiagnosticHelper.GetHelpLinkForDiagnosticId(id),
                customTags: DiagnosticCustomTags.Create(isUnnecessary, isConfigurable, isCustomConfigurable: hasAnyCodeStyleOption, enforceOnBuild));
#pragma warning restore RS0030 // Do not use banned APIs
}