src/Workspaces/CSharp/Portable/SyncedSource/FileBasedPrograms/IBuildService.cs - main - githubmirror/roslyn

src/Workspaces/CSharp/Portable/SyncedSource/FileBasedPrograms/IBuildService.cs

86 строк2 KB

Jan Jones

Allow MSBuildWorkspace to open file-based apps (#84139)

30 июл 2026, 11:03

30 июл 2026, 11:037e7ebef

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

#nullable enable

using System.Collections.Generic;
using System.Collections.Immutable;
using System.Threading.Tasks;
using System.Xml;

namespace Microsoft.DotNet.FileBasedPrograms;

/// <summary>
/// The root interface for our abstraction over MSBuild APIs.
/// This is used by <c>VirtualProjectBuilder</c> so that it can be used
/// both by dotnet CLI (which uses MSBuild APIs directly)
/// and by roslyn IDE (which uses MSBuild through RPC).
/// </summary>
#if FILE_BASED_PROGRAMS_PUBLIC
public
#else
internal
#endif
interface IBuildService
{
    /// <summary>
    /// An abstraction over MSBuild's <c>ProjectInstance.FromProjectRootElement</c> method.
    /// </summary>
    /// <param name="additionalGlobalProperties">
    /// NOTE: Unlike the MSBuild API, these properties are automatically merged with <paramref name="projectCollection"/>'s global properties
    /// (the latter come first, so the former can overwrite them).
    /// </param>
    ValueTask<IProjectInstance> CreateProjectInstanceFromProjectRootElementAsync(
        IProjectRootElement projectRoot,
        IProjectCollection projectCollection,
        IDictionary<string, string>? additionalGlobalProperties);

    /// <summary>
    /// An abstraction over MSBuild's <c>ProjectRootElement.Create</c> method.
    /// </summary>
    IProjectRootElement CreateProjectRootElement(XmlReader xmlReader, IProjectCollection projectCollection, string entryPointFilePath);
}

/// <summary>
/// An abstraction of MSBuild's <c>ProjectCollection</c>.
/// </summary>
/// <seealso cref="IBuildService"/>
#if FILE_BASED_PROGRAMS_PUBLIC
public
#else
internal
#endif
interface IProjectCollection
{
}

/// <summary>
/// An abstraction of MSBuild's <c>ProjectInstance</c>.
/// </summary>
/// <seealso cref="IBuildService"/>
#if FILE_BASED_PROGRAMS_PUBLIC
public
#else
internal
#endif
interface IProjectInstance
{
    ValueTask<ImmutableArray<ImmutableArray<string>>> GetItemMetadataValuesAsync(string itemType, ImmutableArray<string> metadataNames);
    ValueTask<string> GetPropertyValueAsync(string propertyName);
    ValueTask<string> ExpandStringAsync(string value);
}

/// <summary>
/// An abstraction of MSBuild's <c>ProjectRootElement</c>.
/// </summary>
/// <seealso cref="IBuildService"/>
#if FILE_BASED_PROGRAMS_PUBLIC
public
#else
internal
#endif
interface IProjectRootElement
{
    string? FullPath { get; set; }
    string GetRawXml();
}