// 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.Threading;
using System.Threading.Tasks;
using Microsoft.CodeAnalysis.Formatting;
using Microsoft.CodeAnalysis.Host;

namespace Microsoft.CodeAnalysis.DecompiledSource;

internal interface IDecompiledSourceService : ILanguageService
{
    /// <summary>
    /// Generates formatted source code containing general information about the symbol's
    /// containing assembly and the decompiled source code which the given ISymbol is or is a part of
    /// into the given document
    /// </summary>
    /// <param name="document">The document to generate source into</param>
    /// <param name="symbolCompilation">The <see cref="Compilation"/> in which symbol is resolved.</param>
    /// <param name="symbol">The symbol to generate source for</param>
    /// <param name="metadataReference">The reference that contains the symbol</param>
    /// <param name="assemblyLocation">The location of the implementation assembly to decompile</param>
    /// <param name="formattingOptions">Options to use to format the generated document, or null to use the default formatting options of the <paramref name="document"/>.</param>
    /// <returns>The updated document, or null if the decompilation could not be performed</returns>
    Task<Document?> AddSourceToAsync(Document document, Compilation symbolCompilation, ISymbol symbol, MetadataReference? metadataReference, string? assemblyLocation, SyntaxFormattingOptions? formattingOptions, CancellationToken cancellationToken);
}