|
// 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;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Roslyn.Utilities;
namespace Microsoft.CodeAnalysis.Diagnostics.EngineV2
{
internal partial class DiagnosticIncrementalAnalyzer
{
/// <summary>
/// This is in charge of anything related to <see cref="StateSet"/>
/// </summary>
private partial class StateManager
{
private readonly Workspace _workspace;
private readonly DiagnosticAnalyzerInfoCache _analyzerInfoCache;
/// <summary>
/// Analyzers supplied by the host (IDE). These are built-in to the IDE, the compiler, or from an installed IDE extension (VSIX).
/// Maps language name to the analyzers and their state.
/// </summary>
private ImmutableDictionary<HostAnalyzerStateSetKey, HostAnalyzerStateSets> _hostAnalyzerStateMap;
/// <summary>
/// Analyzers referenced by the project via a PackageReference. Updates are protected by _projectAnalyzerStateMapGuard.
/// ImmutableDictionary used to present a safe, non-immutable view to users.
/// </summary>
private ImmutableDictionary<ProjectId, ProjectAnalyzerStateSets> _projectAnalyzerStateMap;
/// <summary>
/// Guard around updating _projectAnalyzerStateMap. This is used in UpdateProjectStateSets to avoid
/// duplicated calculations for a project during contentious calls.
/// </summary>
private readonly SemaphoreSlim _projectAnalyzerStateMapGuard = new(1);
/// <summary>
/// This will be raised whenever <see cref="StateManager"/> finds <see cref="Project.AnalyzerReferences"/> change
/// </summary>
public event EventHandler<ProjectAnalyzerReferenceChangedEventArgs>? ProjectAnalyzerReferenceChanged;
public StateManager(Workspace workspace, DiagnosticAnalyzerInfoCache analyzerInfoCache)
{
_workspace = workspace;
_analyzerInfoCache = analyzerInfoCache;
_hostAnalyzerStateMap = ImmutableDictionary<HostAnalyzerStateSetKey, HostAnalyzerStateSets>.Empty;
_projectAnalyzerStateMap = ImmutableDictionary<ProjectId, ProjectAnalyzerStateSets>.Empty;
}
/// <summary>
/// Return <see cref="StateSet"/>s for the given <see cref="ProjectId"/>.
/// This will never create new <see cref="StateSet"/> but will return ones already created.
/// </summary>
public IEnumerable<StateSet> GetStateSets(ProjectId projectId)
{
var hostStateSets = GetAllHostStateSets();
// No need to use _projectAnalyzerStateMapGuard during reads of _projectAnalyzerStateMap
return _projectAnalyzerStateMap.TryGetValue(projectId, out var entry)
? hostStateSets.Concat(entry.StateSetMap.Values)
: hostStateSets;
}
/// <summary>
/// Return <see cref="StateSet"/>s for the given <see cref="Project"/>.
/// This will never create new <see cref="StateSet"/> but will return ones already created.
/// Difference with <see cref="GetStateSets(ProjectId)"/> is that
/// this will only return <see cref="StateSet"/>s that have same language as <paramref name="project"/>.
/// </summary>
public IEnumerable<StateSet> GetStateSets(Project project)
=> GetStateSets(project.Id).Where(s => s.Language == project.Language);
/// <summary>
/// Return <see cref="StateSet"/>s for the given <see cref="Project"/>.
/// This will either return already created <see cref="StateSet"/>s for the specific snapshot of <see cref="Project"/> or
/// it will create new <see cref="StateSet"/>s for the <see cref="Project"/> and update internal state.
/// </summary>
public async Task<ImmutableArray<StateSet>> GetOrCreateStateSetsAsync(Project project, CancellationToken cancellationToken)
{
var projectStateSets = await GetOrCreateProjectStateSetsAsync(project, cancellationToken).ConfigureAwait(false);
return GetOrCreateHostStateSets(project, projectStateSets).OrderedStateSets.AddRange(projectStateSets.StateSetMap.Values);
}
/// <summary>
/// Return <see cref="StateSet"/> for the given <see cref="DiagnosticAnalyzer"/> in the context of <see cref="Project"/>.
/// This will either return already created <see cref="StateSet"/> for the specific snapshot of <see cref="Project"/> or
/// it will create new <see cref="StateSet"/> for the <see cref="Project"/>. and update internal state.
/// </summary>
public async Task<StateSet?> GetOrCreateStateSetAsync(Project project, DiagnosticAnalyzer analyzer, CancellationToken cancellationToken)
{
var projectStateSets = await GetOrCreateProjectStateSetsAsync(project, cancellationToken).ConfigureAwait(false);
if (projectStateSets.StateSetMap.TryGetValue(analyzer, out var stateSet))
{
return stateSet;
}
var hostStateSetMap = GetOrCreateHostStateSets(project, projectStateSets).StateSetMap;
if (hostStateSetMap.TryGetValue(analyzer, out stateSet))
{
return stateSet;
}
return null;
}
public bool OnProjectRemoved(IEnumerable<StateSet> stateSets, ProjectId projectId)
{
var removed = false;
foreach (var stateSet in stateSets)
{
removed |= stateSet.OnProjectRemoved(projectId);
}
lock (_projectAnalyzerStateMap)
{
_projectAnalyzerStateMap = _projectAnalyzerStateMap.Remove(projectId);
}
return removed;
}
private void RaiseProjectAnalyzerReferenceChanged(ProjectAnalyzerReferenceChangedEventArgs args)
=> ProjectAnalyzerReferenceChanged?.Invoke(this, args);
private static ImmutableDictionary<DiagnosticAnalyzer, StateSet> CreateStateSetMap(
string language,
IEnumerable<ImmutableArray<DiagnosticAnalyzer>> projectAnalyzerCollection,
IEnumerable<ImmutableArray<DiagnosticAnalyzer>> hostAnalyzerCollection,
bool includeWorkspacePlaceholderAnalyzers)
{
var builder = ImmutableDictionary.CreateBuilder<DiagnosticAnalyzer, StateSet>();
if (includeWorkspacePlaceholderAnalyzers)
{
builder.Add(FileContentLoadAnalyzer.Instance, new StateSet(language, FileContentLoadAnalyzer.Instance, isHostAnalyzer: true));
builder.Add(GeneratorDiagnosticsPlaceholderAnalyzer.Instance, new StateSet(language, GeneratorDiagnosticsPlaceholderAnalyzer.Instance, isHostAnalyzer: true));
}
foreach (var analyzers in projectAnalyzerCollection)
{
foreach (var analyzer in analyzers)
{
Debug.Assert(analyzer != FileContentLoadAnalyzer.Instance && analyzer != GeneratorDiagnosticsPlaceholderAnalyzer.Instance);
// TODO:
// #1, all de-duplication should move to DiagnosticAnalyzerInfoCache
// #2, not sure whether de-duplication of analyzer itself makes sense. this can only happen
// if user deliberately put same analyzer twice.
if (builder.ContainsKey(analyzer))
{
continue;
}
builder.Add(analyzer, new StateSet(language, analyzer, isHostAnalyzer: false));
}
}
foreach (var analyzers in hostAnalyzerCollection)
{
foreach (var analyzer in analyzers)
{
Debug.Assert(analyzer != FileContentLoadAnalyzer.Instance && analyzer != GeneratorDiagnosticsPlaceholderAnalyzer.Instance);
// TODO:
// #1, all de-duplication should move to DiagnosticAnalyzerInfoCache
// #2, not sure whether de-duplication of analyzer itself makes sense. this can only happen
// if user deliberately put same analyzer twice.
if (builder.ContainsKey(analyzer))
{
continue;
}
builder.Add(analyzer, new StateSet(language, analyzer, isHostAnalyzer: true));
}
}
return builder.ToImmutable();
}
private readonly struct HostAnalyzerStateSetKey : IEquatable<HostAnalyzerStateSetKey>
{
public HostAnalyzerStateSetKey(string language, bool hasSdkCodeStyleAnalyzers, IReadOnlyList<AnalyzerReference> analyzerReferences)
{
Language = language;
HasSdkCodeStyleAnalyzers = hasSdkCodeStyleAnalyzers;
AnalyzerReferences = analyzerReferences;
}
public string Language { get; }
public bool HasSdkCodeStyleAnalyzers { get; }
public IReadOnlyList<AnalyzerReference> AnalyzerReferences { get; }
public bool Equals(HostAnalyzerStateSetKey other)
=> Language == other.Language &&
HasSdkCodeStyleAnalyzers == other.HasSdkCodeStyleAnalyzers &&
AnalyzerReferences == other.AnalyzerReferences;
public override bool Equals(object? obj)
=> obj is HostAnalyzerStateSetKey key && Equals(key);
public override int GetHashCode()
=> Hash.Combine(Language.GetHashCode(),
Hash.Combine(HasSdkCodeStyleAnalyzers.GetHashCode(), AnalyzerReferences.GetHashCode()));
}
}
}
}
|