Class CompilationWithAnalyzers

Inheritance

object

CompilationWithAnalyzers

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Microsoft.CodeAnalysis.Diagnostics

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public class CompilationWithAnalyzers

Constructors

CompilationWithAnalyzers(Compilation, ImmutableArray<DiagnosticAnalyzer>, AnalyzerOptions?)

Declaration

public CompilationWithAnalyzers(Compilation compilation, ImmutableArray<DiagnosticAnalyzer> analyzers, AnalyzerOptions? options)

Parameters

Type	Name	Description
Compilation	compilation
ImmutableArray<DiagnosticAnalyzer>	analyzers
AnalyzerOptions	options

CompilationWithAnalyzers(Compilation, ImmutableArray<DiagnosticAnalyzer>, CompilationWithAnalyzersOptions)

Declaration

public CompilationWithAnalyzers(Compilation compilation, ImmutableArray<DiagnosticAnalyzer> analyzers, CompilationWithAnalyzersOptions analysisOptions)

Parameters

Type	Name	Description
Compilation	compilation
ImmutableArray<DiagnosticAnalyzer>	analyzers
CompilationWithAnalyzersOptions	analysisOptions

Properties

AnalysisOptions

Declaration

public CompilationWithAnalyzersOptions AnalysisOptions { get; }

Property Value

Type	Description
CompilationWithAnalyzersOptions

Analyzers

Declaration

public ImmutableArray<DiagnosticAnalyzer> Analyzers { get; }

Property Value

Type	Description
ImmutableArray<DiagnosticAnalyzer>

Compilation

Declaration

public Compilation Compilation { get; }

Property Value

Type	Description
Compilation

Methods

ClearAnalyzerState(ImmutableArray<DiagnosticAnalyzer>)

Declaration

[Obsolete("This API is no longer required to be invoked. Analyzer state is automatically cleaned up when CompilationWithAnalyzers instance is released.")]
public static void ClearAnalyzerState(ImmutableArray<DiagnosticAnalyzer> analyzers)

Parameters

Type	Name	Description
ImmutableArray<DiagnosticAnalyzer>	analyzers

GetAllDiagnosticsAsync(CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAllDiagnosticsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalysisResultAsync(AdditionalText, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(AdditionalText file, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
AdditionalText	file
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(AdditionalText, TextSpan?, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(AdditionalText file, TextSpan? filterSpan, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
AdditionalText	file
TextSpan?	filterSpan
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(AdditionalText, TextSpan?, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(AdditionalText file, TextSpan? filterSpan, CancellationToken cancellationToken)

Parameters

Type	Name	Description
AdditionalText	file
TextSpan?	filterSpan
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(AdditionalText, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(AdditionalText file, CancellationToken cancellationToken)

Parameters

Type	Name	Description
AdditionalText	file
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SemanticModel, TextSpan?, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SemanticModel model, TextSpan? filterSpan, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SemanticModel	model
TextSpan?	filterSpan
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SemanticModel, TextSpan?, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SemanticModel model, TextSpan? filterSpan, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SemanticModel	model
TextSpan?	filterSpan
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SyntaxTree, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SyntaxTree tree, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SyntaxTree, TextSpan?, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SyntaxTree tree, TextSpan? filterSpan, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
TextSpan?	filterSpan
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SyntaxTree, TextSpan?, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SyntaxTree tree, TextSpan? filterSpan, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
TextSpan?	filterSpan
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(SyntaxTree, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(SyntaxTree tree, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalysisResultAsync(CancellationToken)

Declaration

public Task<AnalysisResult> GetAnalysisResultAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalysisResult>

GetAnalyzerCompilationDiagnosticsAsync(ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

[Obsolete("This API was found to have performance issues and hence has been deprecated. Instead, invoke the API 'GetAnalysisResultAsync' and access the property 'CompilationDiagnostics' on the returned 'AnalysisResult' to fetch the compilation diagnostics.")]
public Task<ImmutableArray<Diagnostic>> GetAnalyzerCompilationDiagnosticsAsync(ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerCompilationDiagnosticsAsync(CancellationToken)

Declaration

[Obsolete("This API was found to have performance issues and hence has been deprecated. Instead, invoke the API 'GetAnalysisResultAsync' and access the property 'CompilationDiagnostics' on the returned 'AnalysisResult' to fetch the compilation diagnostics.")]
public Task<ImmutableArray<Diagnostic>> GetAnalyzerCompilationDiagnosticsAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerDiagnosticsAsync(ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerDiagnosticsAsync(ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerDiagnosticsAsync(CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerDiagnosticsAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSemanticDiagnosticsAsync(SemanticModel, TextSpan?, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSemanticDiagnosticsAsync(SemanticModel model, TextSpan? filterSpan, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SemanticModel	model
TextSpan?	filterSpan
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSemanticDiagnosticsAsync(SemanticModel, TextSpan?, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSemanticDiagnosticsAsync(SemanticModel model, TextSpan? filterSpan, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SemanticModel	model
TextSpan?	filterSpan
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree tree, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree, TextSpan?, ImmutableArray<DiagnosticAnalyzer>, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree tree, TextSpan? filterSpan, ImmutableArray<DiagnosticAnalyzer> analyzers, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
TextSpan?	filterSpan
ImmutableArray<DiagnosticAnalyzer>	analyzers
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree, TextSpan?, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree tree, TextSpan? filterSpan, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
TextSpan?	filterSpan
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree, CancellationToken)

Declaration

public Task<ImmutableArray<Diagnostic>> GetAnalyzerSyntaxDiagnosticsAsync(SyntaxTree tree, CancellationToken cancellationToken)

Parameters

Type	Name	Description
SyntaxTree	tree
CancellationToken	cancellationToken

Returns

Type	Description
Task<ImmutableArray<Diagnostic>>

GetAnalyzerTelemetryInfoAsync(DiagnosticAnalyzer, CancellationToken)

Declaration

public Task<AnalyzerTelemetryInfo> GetAnalyzerTelemetryInfoAsync(DiagnosticAnalyzer analyzer, CancellationToken cancellationToken)

Parameters

Type	Name	Description
DiagnosticAnalyzer	analyzer
CancellationToken	cancellationToken

Returns

Type	Description
Task<AnalyzerTelemetryInfo>

GetEffectiveDiagnostics(IEnumerable<Diagnostic>, Compilation)

Declaration

public static IEnumerable<Diagnostic> GetEffectiveDiagnostics(IEnumerable<Diagnostic> diagnostics, Compilation compilation)

Parameters

Type	Name	Description
IEnumerable<Diagnostic>	diagnostics
Compilation	compilation

Returns

Type	Description
IEnumerable<Diagnostic>

GetEffectiveDiagnostics(ImmutableArray<Diagnostic>, Compilation)

Declaration

public static IEnumerable<Diagnostic> GetEffectiveDiagnostics(ImmutableArray<Diagnostic> diagnostics, Compilation compilation)

Parameters

Type	Name	Description
ImmutableArray<Diagnostic>	diagnostics
Compilation	compilation

Returns

Type	Description
IEnumerable<Diagnostic>

IsDiagnosticAnalyzerSuppressed(DiagnosticAnalyzer, CompilationOptions, Action<Exception, DiagnosticAnalyzer, Diagnostic>?)

Declaration

[Obsolete("This API is no longer supported. See https://github.com/dotnet/roslyn/issues/67592 for details")]
public static bool IsDiagnosticAnalyzerSuppressed(DiagnosticAnalyzer analyzer, CompilationOptions options, Action<Exception, DiagnosticAnalyzer, Diagnostic>? onAnalyzerException = null)

Parameters

Type	Name	Description
DiagnosticAnalyzer	analyzer
CompilationOptions	options
Action<Exception, DiagnosticAnalyzer, Diagnostic>	onAnalyzerException

Returns

Type	Description
bool