/// <summary>
/// Compute <see cref="DiagnosticAnalyzer.SupportedDiagnostics"/> and exception handler for the given <paramref name="analyzer"/>.
/// </summary>
private static ImmutableArray <DiagnosticDescriptor> ComputeDiagnosticDescriptors(
DiagnosticAnalyzer analyzer,
AnalyzerExecutor analyzerExecutor)
{
var supportedDiagnostics = ImmutableArray <DiagnosticDescriptor> .Empty;
// Catch Exception from analyzer.SupportedDiagnostics
analyzerExecutor.ExecuteAndCatchIfThrows(
analyzer,
_ =>
{
var supportedDiagnosticsLocal = analyzer.SupportedDiagnostics;
if (!supportedDiagnosticsLocal.IsDefaultOrEmpty)
{
foreach (var descriptor in supportedDiagnosticsLocal)
{
if (descriptor == null)
{
// Disallow null descriptors.
throw new ArgumentException(string.Format(CodeAnalysisResources.SupportedDiagnosticsHasNullDescriptor, analyzer.ToString()), nameof(DiagnosticAnalyzer.SupportedDiagnostics));
}
}
supportedDiagnostics = supportedDiagnosticsLocal;
}
},
argument: default(object));
// Force evaluate and report exception diagnostics from LocalizableString.ToString().
Action <Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException = analyzerExecutor.OnAnalyzerException;
if (onAnalyzerException != null)
{
var handler = new EventHandler <Exception>((sender, ex) =>
{
var diagnostic = AnalyzerExecutor.CreateAnalyzerExceptionDiagnostic(analyzer, ex);
onAnalyzerException(ex, analyzer, diagnostic);
});
foreach (var descriptor in supportedDiagnostics)
{
ForceLocalizableStringExceptions(descriptor.Title, handler);
ForceLocalizableStringExceptions(descriptor.MessageFormat, handler);
ForceLocalizableStringExceptions(descriptor.Description, handler);
}
}
return(supportedDiagnostics);
}
/// <summary>
/// Return <see cref="DiagnosticAnalyzer.SupportedDiagnostics"/> of given <paramref name="analyzer"/>.
/// </summary>
public ImmutableArray <DiagnosticDescriptor> GetSupportedDiagnosticDescriptors(
DiagnosticAnalyzer analyzer,
AnalyzerExecutor analyzerExecutor)
{
var descriptors = _descriptorCache.GetOrAdd(analyzer, key =>
{
var supportedDiagnostics = ImmutableArray <DiagnosticDescriptor> .Empty;
// Catch Exception from analyzer.SupportedDiagnostics
analyzerExecutor.ExecuteAndCatchIfThrows(analyzer, () =>
{
var supportedDiagnosticsLocal = analyzer.SupportedDiagnostics;
if (!supportedDiagnosticsLocal.IsDefaultOrEmpty)
{
supportedDiagnostics = supportedDiagnosticsLocal;
}
});
EventHandler <Exception> handler = null;
Action <Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException = analyzerExecutor.OnAnalyzerException;
if (onAnalyzerException != null)
{
handler = new EventHandler <Exception>((sender, ex) =>
{
var diagnostic = AnalyzerExecutor.CreateAnalyzerExceptionDiagnostic(analyzer, ex);
onAnalyzerException(ex, analyzer, diagnostic);
});
// Subscribe for exceptions from lazily evaluated localizable strings in the descriptors.
foreach (var descriptor in supportedDiagnostics)
{
descriptor.Title.OnException += handler;
descriptor.MessageFormat.OnException += handler;
descriptor.Description.OnException += handler;
}
}
return(Tuple.Create(supportedDiagnostics, handler));
});
return(descriptors.Item1);
}
/// <summary>
/// Compute <see cref="DiagnosticAnalyzer.SupportedDiagnostics"/> and exception handler for the given <paramref name="analyzer"/>.
/// </summary>
private static Tuple <ImmutableArray <DiagnosticDescriptor>, EventHandler <Exception> > ComputeDescriptorsAndHandler(
DiagnosticAnalyzer analyzer,
AnalyzerExecutor analyzerExecutor)
{
var supportedDiagnostics = ImmutableArray <DiagnosticDescriptor> .Empty;
// Catch Exception from analyzer.SupportedDiagnostics
analyzerExecutor.ExecuteAndCatchIfThrows(analyzer, () =>
{
var supportedDiagnosticsLocal = analyzer.SupportedDiagnostics;
if (!supportedDiagnosticsLocal.IsDefaultOrEmpty)
{
supportedDiagnostics = supportedDiagnosticsLocal;
}
});
EventHandler <Exception> handler = null;
Action <Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException = analyzerExecutor.OnAnalyzerException;
if (onAnalyzerException != null)
{
handler = new EventHandler <Exception>((sender, ex) =>
{
var diagnostic = AnalyzerExecutor.CreateAnalyzerExceptionDiagnostic(analyzer, ex);
onAnalyzerException(ex, analyzer, diagnostic);
});
// Subscribe for exceptions from lazily evaluated localizable strings in the descriptors.
// REVIEW: find out better way to handle these exception handlers. right now, it can leak
// so easily unless ClearAnalyzerState is called from host properly
foreach (var descriptor in supportedDiagnostics)
{
descriptor.Title.OnException += handler;
descriptor.MessageFormat.OnException += handler;
descriptor.Description.OnException += handler;
}
}
return(Tuple.Create(supportedDiagnostics, handler));
}
/// <summary>
/// Compute <see cref="DiagnosticAnalyzer.SupportedDiagnostics"/> and exception handler for the given <paramref name="analyzer"/>.
/// </summary>
private static ImmutableArray <DiagnosticDescriptor> ComputeDescriptors(
DiagnosticAnalyzer analyzer,
AnalyzerExecutor analyzerExecutor)
{
var supportedDiagnostics = ImmutableArray <DiagnosticDescriptor> .Empty;
// Catch Exception from analyzer.SupportedDiagnostics
analyzerExecutor.ExecuteAndCatchIfThrows(analyzer, () =>
{
var supportedDiagnosticsLocal = analyzer.SupportedDiagnostics;
if (!supportedDiagnosticsLocal.IsDefaultOrEmpty)
{
supportedDiagnostics = supportedDiagnosticsLocal;
}
});
// Force evaluate and report exception diagnostics from LocalizableString.ToString().
Action <Exception, DiagnosticAnalyzer, Diagnostic> onAnalyzerException = analyzerExecutor.OnAnalyzerException;
if (onAnalyzerException != null)
{
var handler = new EventHandler <Exception>((sender, ex) =>
{
var diagnostic = AnalyzerExecutor.CreateAnalyzerExceptionDiagnostic(analyzer, ex);
onAnalyzerException(ex, analyzer, diagnostic);
});
foreach (var descriptor in supportedDiagnostics)
{
ForceLocalizableStringExceptions(descriptor.Title, handler);
ForceLocalizableStringExceptions(descriptor.MessageFormat, handler);
ForceLocalizableStringExceptions(descriptor.Description, handler);
}
}
return(supportedDiagnostics);
}
