/*
 * SonarAnalyzer for .NET
 * Copyright (C) 2015-2017 SonarSource SA
 * mailto: contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

using System.Threading.Tasks;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CodeFixes;

namespace SonarAnalyzer.Helpers
{
    public abstract class SonarCodeFixProvider : CodeFixProvider
    {
        public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context)
        {
            if (!context.Document.SupportsSyntaxTree)
            {
                return;
            }

            var syntaxRoot = await context.Document.GetSyntaxRootAsync(context.CancellationToken).ConfigureAwait(false);
            var syntaxTree = syntaxRoot.SyntaxTree;

            /// This only disables codefixes when different versions are loaded
            /// In case of analyzers, <see cref="SonarAnalysisContext.IsAnalysisDisabled"/> is sufficient, because Roslyn only
            /// creates a single instance from each assembly-version, so we can disable the VSIX analyzers
            /// In case of code fix providers Roslyn creates multiple instances of the code fix providers. Which means that
            /// we can only disable one of them if they are created from different assembly-versions.
            /// If the VSIX and the Nuget has the same version, then code fixes show up multiple times, this ticket will fix
            /// this problem: https://github.com/dotnet/roslyn/issues/4030
            if (SonarAnalysisContext.IsAnalysisDisabled(syntaxTree))
            {
                return;
            }

            await RegisterCodeFixesAsync(syntaxRoot, context).ConfigureAwait(false);
        }

        protected abstract Task RegisterCodeFixesAsync(SyntaxNode root, CodeFixContext context);
    }
}
