Class Compilation

Inheritance
object
Compilation
CSharpCompilation
Inherited Members
Namespace: Microsoft.CodeAnalysis
Assembly: Microsoft.CodeAnalysis.dll
Syntax
public abstract class Compilation

Fields

_features

Declaration
protected readonly IReadOnlyDictionary<string, string> _features
Field Value
Type Description
IReadOnlyDictionary<string, string>

Properties

Assembly

Declaration
public IAssemblySymbol Assembly { get; }
Property Value
Type Description
IAssemblySymbol

AssemblyName

Declaration
public string? AssemblyName { get; }
Property Value
Type Description
string

CommonAssembly

Declaration
protected abstract IAssemblySymbol CommonAssembly { get; }
Property Value
Type Description
IAssemblySymbol

CommonDynamicType

Declaration
protected abstract ITypeSymbol CommonDynamicType { get; }
Property Value
Type Description
ITypeSymbol

CommonGlobalNamespace

Declaration
protected abstract INamespaceSymbol CommonGlobalNamespace { get; }
Property Value
Type Description
INamespaceSymbol

CommonObjectType

Declaration
protected abstract INamedTypeSymbol CommonObjectType { get; }
Property Value
Type Description
INamedTypeSymbol

CommonOptions

Declaration
protected abstract CompilationOptions CommonOptions { get; }
Property Value
Type Description
CompilationOptions

CommonScriptClass

Declaration
protected abstract INamedTypeSymbol? CommonScriptClass { get; }
Property Value
Type Description
INamedTypeSymbol

CommonScriptGlobalsType

Declaration
protected abstract ITypeSymbol? CommonScriptGlobalsType { get; }
Property Value
Type Description
ITypeSymbol

CommonSourceModule

Declaration
protected abstract IModuleSymbol CommonSourceModule { get; }
Property Value
Type Description
IModuleSymbol

CommonSyntaxTrees

Declaration
protected abstract ImmutableArray<SyntaxTree> CommonSyntaxTrees { get; }
Property Value
Type Description
ImmutableArray<SyntaxTree>

DirectiveReferences

Declaration
public abstract ImmutableArray<MetadataReference> DirectiveReferences { get; }
Property Value
Type Description
ImmutableArray<MetadataReference>

DynamicType

Declaration
public ITypeSymbol DynamicType { get; }
Property Value
Type Description
ITypeSymbol

ExternalReferences

Declaration
public ImmutableArray<MetadataReference> ExternalReferences { get; }
Property Value
Type Description
ImmutableArray<MetadataReference>

GlobalNamespace

Declaration
public INamespaceSymbol GlobalNamespace { get; }
Property Value
Type Description
INamespaceSymbol

IsCaseSensitive

Declaration
public abstract bool IsCaseSensitive { get; }
Property Value
Type Description
bool

Language

Declaration
public abstract string Language { get; }
Property Value
Type Description
string

ObjectType

Declaration
public INamedTypeSymbol ObjectType { get; }
Property Value
Type Description
INamedTypeSymbol

Options

Declaration
public CompilationOptions Options { get; }
Property Value
Type Description
CompilationOptions

ReferencedAssemblyNames

Declaration
public abstract IEnumerable<AssemblyIdentity> ReferencedAssemblyNames { get; }
Property Value
Type Description
IEnumerable<AssemblyIdentity>

References

Declaration
public IEnumerable<MetadataReference> References { get; }
Property Value
Type Description
IEnumerable<MetadataReference>

ScriptClass

Declaration
public INamedTypeSymbol? ScriptClass { get; }
Property Value
Type Description
INamedTypeSymbol

ScriptCompilationInfo

Declaration
public ScriptCompilationInfo? ScriptCompilationInfo { get; }
Property Value
Type Description
ScriptCompilationInfo

SourceModule

Declaration
public IModuleSymbol SourceModule { get; }
Property Value
Type Description
IModuleSymbol

SyntaxTrees

Declaration
public IEnumerable<SyntaxTree> SyntaxTrees { get; }
Property Value
Type Description
IEnumerable<SyntaxTree>

Methods

AddReferences(params MetadataReference[])

Declaration
public Compilation AddReferences(params MetadataReference[] references)
Parameters
Type Name Description
MetadataReference[] references
Returns
Type Description
Compilation

AddReferences(IEnumerable<MetadataReference>)

Declaration
public Compilation AddReferences(IEnumerable<MetadataReference> references)
Parameters
Type Name Description
IEnumerable<MetadataReference> references
Returns
Type Description
Compilation

AddSyntaxTrees(params SyntaxTree[])

Declaration
public Compilation AddSyntaxTrees(params SyntaxTree[] trees)
Parameters
Type Name Description
SyntaxTree[] trees
Returns
Type Description
Compilation

AddSyntaxTrees(IEnumerable<SyntaxTree>)

Declaration
public Compilation AddSyntaxTrees(IEnumerable<SyntaxTree> trees)
Parameters
Type Name Description
IEnumerable<SyntaxTree> trees
Returns
Type Description
Compilation

AppendDefaultVersionResource(Stream)

Declaration
protected abstract void AppendDefaultVersionResource(Stream resourceStream)
Parameters
Type Name Description
Stream resourceStream

CheckTupleElementLocations(int, ImmutableArray<Location?>)

Declaration
protected static void CheckTupleElementLocations(int cardinality, ImmutableArray<Location?> elementLocations)
Parameters
Type Name Description
int cardinality
ImmutableArray<Location> elementLocations

CheckTupleElementNames(int, ImmutableArray<string?>)

Declaration
protected static ImmutableArray<string?> CheckTupleElementNames(int cardinality, ImmutableArray<string?> elementNames)
Parameters
Type Name Description
int cardinality
ImmutableArray<string> elementNames
Returns
Type Description
ImmutableArray<string>

CheckTupleElementNullableAnnotations(int, ImmutableArray<NullableAnnotation>)

Declaration
protected static void CheckTupleElementNullableAnnotations(int cardinality, ImmutableArray<NullableAnnotation> elementNullableAnnotations)
Parameters
Type Name Description
int cardinality
ImmutableArray<NullableAnnotation> elementNullableAnnotations

ClassifyCommonConversion(ITypeSymbol, ITypeSymbol)

Declaration
public abstract CommonConversion ClassifyCommonConversion(ITypeSymbol source, ITypeSymbol destination)
Parameters
Type Name Description
ITypeSymbol source
ITypeSymbol destination
Returns
Type Description
CommonConversion

Clone()

Declaration
public Compilation Clone()
Returns
Type Description
Compilation

CommonAddSyntaxTrees(IEnumerable<SyntaxTree>)

Declaration
protected abstract Compilation CommonAddSyntaxTrees(IEnumerable<SyntaxTree> trees)
Parameters
Type Name Description
IEnumerable<SyntaxTree> trees
Returns
Type Description
Compilation

CommonBindScriptClass()

Declaration
protected INamedTypeSymbol? CommonBindScriptClass()
Returns
Type Description
INamedTypeSymbol

CommonClone()

Declaration
protected abstract Compilation CommonClone()
Returns
Type Description
Compilation

CommonContainsSyntaxTree(SyntaxTree?)

Declaration
protected abstract bool CommonContainsSyntaxTree(SyntaxTree? syntaxTree)
Parameters
Type Name Description
SyntaxTree syntaxTree
Returns
Type Description
bool

CommonCreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string>, ImmutableArray<Location>, ImmutableArray<bool>, ImmutableArray<NullableAnnotation>)

Declaration
protected abstract INamedTypeSymbol CommonCreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol> memberTypes, ImmutableArray<string> memberNames, ImmutableArray<Location> memberLocations, ImmutableArray<bool> memberIsReadOnly, ImmutableArray<NullableAnnotation> memberNullableAnnotations)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> memberTypes
ImmutableArray<string> memberNames
ImmutableArray<Location> memberLocations
ImmutableArray<bool> memberIsReadOnly
ImmutableArray<NullableAnnotation> memberNullableAnnotations
Returns
Type Description
INamedTypeSymbol

CommonCreateArrayTypeSymbol(ITypeSymbol, int, NullableAnnotation)

Declaration
protected abstract IArrayTypeSymbol CommonCreateArrayTypeSymbol(ITypeSymbol elementType, int rank, NullableAnnotation elementNullableAnnotation)
Parameters
Type Name Description
ITypeSymbol elementType
int rank
NullableAnnotation elementNullableAnnotation
Returns
Type Description
IArrayTypeSymbol

CommonCreateBuiltinOperator(string, ITypeSymbol, ITypeSymbol)

Declaration
protected abstract IMethodSymbol CommonCreateBuiltinOperator(string name, ITypeSymbol returnType, ITypeSymbol operandType)
Parameters
Type Name Description
string name
ITypeSymbol returnType
ITypeSymbol operandType
Returns
Type Description
IMethodSymbol

CommonCreateBuiltinOperator(string, ITypeSymbol, ITypeSymbol, ITypeSymbol)

Declaration
protected abstract IMethodSymbol CommonCreateBuiltinOperator(string name, ITypeSymbol returnType, ITypeSymbol leftType, ITypeSymbol rightType)
Parameters
Type Name Description
string name
ITypeSymbol returnType
ITypeSymbol leftType
ITypeSymbol rightType
Returns
Type Description
IMethodSymbol

CommonCreateErrorNamespaceSymbol(INamespaceSymbol, string)

Declaration
protected abstract INamespaceSymbol CommonCreateErrorNamespaceSymbol(INamespaceSymbol container, string name)
Parameters
Type Name Description
INamespaceSymbol container
string name
Returns
Type Description
INamespaceSymbol

CommonCreateErrorTypeSymbol(INamespaceOrTypeSymbol?, string, int)

Declaration
protected abstract INamedTypeSymbol CommonCreateErrorTypeSymbol(INamespaceOrTypeSymbol? container, string name, int arity)
Parameters
Type Name Description
INamespaceOrTypeSymbol container
string name
int arity
Returns
Type Description
INamedTypeSymbol

CommonCreateFunctionPointerTypeSymbol(ITypeSymbol, RefKind, ImmutableArray<ITypeSymbol>, ImmutableArray<RefKind>, SignatureCallingConvention, ImmutableArray<INamedTypeSymbol>)

Declaration
protected abstract IFunctionPointerTypeSymbol CommonCreateFunctionPointerTypeSymbol(ITypeSymbol returnType, RefKind returnRefKind, ImmutableArray<ITypeSymbol> parameterTypes, ImmutableArray<RefKind> parameterRefKinds, SignatureCallingConvention callingConvention, ImmutableArray<INamedTypeSymbol> callingConventionTypes)
Parameters
Type Name Description
ITypeSymbol returnType
RefKind returnRefKind
ImmutableArray<ITypeSymbol> parameterTypes
ImmutableArray<RefKind> parameterRefKinds
SignatureCallingConvention callingConvention
ImmutableArray<INamedTypeSymbol> callingConventionTypes
Returns
Type Description
IFunctionPointerTypeSymbol

CommonCreateNativeIntegerTypeSymbol(bool)

Declaration
protected abstract INamedTypeSymbol CommonCreateNativeIntegerTypeSymbol(bool signed)
Parameters
Type Name Description
bool signed
Returns
Type Description
INamedTypeSymbol

CommonCreatePointerTypeSymbol(ITypeSymbol)

Declaration
protected abstract IPointerTypeSymbol CommonCreatePointerTypeSymbol(ITypeSymbol elementType)
Parameters
Type Name Description
ITypeSymbol elementType
Returns
Type Description
IPointerTypeSymbol

CommonCreateTupleTypeSymbol(INamedTypeSymbol, ImmutableArray<string?>, ImmutableArray<Location?>, ImmutableArray<NullableAnnotation>)

Declaration
protected abstract INamedTypeSymbol CommonCreateTupleTypeSymbol(INamedTypeSymbol underlyingType, ImmutableArray<string?> elementNames, ImmutableArray<Location?> elementLocations, ImmutableArray<NullableAnnotation> elementNullableAnnotations)
Parameters
Type Name Description
INamedTypeSymbol underlyingType
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
ImmutableArray<NullableAnnotation> elementNullableAnnotations
Returns
Type Description
INamedTypeSymbol

CommonCreateTupleTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string?>, ImmutableArray<Location?>, ImmutableArray<NullableAnnotation>)

Declaration
protected abstract INamedTypeSymbol CommonCreateTupleTypeSymbol(ImmutableArray<ITypeSymbol> elementTypes, ImmutableArray<string?> elementNames, ImmutableArray<Location?> elementLocations, ImmutableArray<NullableAnnotation> elementNullableAnnotations)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> elementTypes
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
ImmutableArray<NullableAnnotation> elementNullableAnnotations
Returns
Type Description
INamedTypeSymbol

CommonGetAssemblyOrModuleSymbol(MetadataReference)

Declaration
protected abstract ISymbol? CommonGetAssemblyOrModuleSymbol(MetadataReference reference)
Parameters
Type Name Description
MetadataReference reference
Returns
Type Description
ISymbol

CommonGetCompilationNamespace(INamespaceSymbol)

Declaration
protected abstract INamespaceSymbol? CommonGetCompilationNamespace(INamespaceSymbol namespaceSymbol)
Parameters
Type Name Description
INamespaceSymbol namespaceSymbol
Returns
Type Description
INamespaceSymbol

CommonGetEntryPoint(CancellationToken)

Declaration
protected abstract IMethodSymbol? CommonGetEntryPoint(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IMethodSymbol

CommonGetSemanticModel(SyntaxTree, SemanticModelOptions)

Declaration
protected abstract SemanticModel CommonGetSemanticModel(SyntaxTree syntaxTree, SemanticModelOptions options)
Parameters
Type Name Description
SyntaxTree syntaxTree
SemanticModelOptions options
Returns
Type Description
SemanticModel

CommonGetTypeByMetadataName(string)

Declaration
protected abstract INamedTypeSymbol? CommonGetTypeByMetadataName(string metadataName)
Parameters
Type Name Description
string metadataName
Returns
Type Description
INamedTypeSymbol

CommonRemoveAllSyntaxTrees()

Declaration
protected abstract Compilation CommonRemoveAllSyntaxTrees()
Returns
Type Description
Compilation

CommonRemoveSyntaxTrees(IEnumerable<SyntaxTree>)

Declaration
protected abstract Compilation CommonRemoveSyntaxTrees(IEnumerable<SyntaxTree> trees)
Parameters
Type Name Description
IEnumerable<SyntaxTree> trees
Returns
Type Description
Compilation

CommonReplaceSyntaxTree(SyntaxTree, SyntaxTree)

Declaration
protected abstract Compilation CommonReplaceSyntaxTree(SyntaxTree oldTree, SyntaxTree newTree)
Parameters
Type Name Description
SyntaxTree oldTree
SyntaxTree newTree
Returns
Type Description
Compilation

CommonWithAssemblyName(string?)

Declaration
protected abstract Compilation CommonWithAssemblyName(string? outputName)
Parameters
Type Name Description
string outputName
Returns
Type Description
Compilation

CommonWithOptions(CompilationOptions)

Declaration
protected abstract Compilation CommonWithOptions(CompilationOptions options)
Parameters
Type Name Description
CompilationOptions options
Returns
Type Description
Compilation

CommonWithReferences(IEnumerable<MetadataReference>)

Declaration
protected abstract Compilation CommonWithReferences(IEnumerable<MetadataReference> newReferences)
Parameters
Type Name Description
IEnumerable<MetadataReference> newReferences
Returns
Type Description
Compilation

CommonWithScriptCompilationInfo(ScriptCompilationInfo?)

Declaration
protected abstract Compilation CommonWithScriptCompilationInfo(ScriptCompilationInfo? info)
Parameters
Type Name Description
ScriptCompilationInfo info
Returns
Type Description
Compilation

ContainsSymbolsWithName(Func<string, bool>, SymbolFilter, CancellationToken)

Declaration
public abstract bool ContainsSymbolsWithName(Func<string, bool> predicate, SymbolFilter filter = SymbolFilter.TypeAndMember, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Func<string, bool> predicate
SymbolFilter filter
CancellationToken cancellationToken
Returns
Type Description
bool

ContainsSymbolsWithName(string, SymbolFilter, CancellationToken)

Declaration
public abstract bool ContainsSymbolsWithName(string name, SymbolFilter filter = SymbolFilter.TypeAndMember, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name
SymbolFilter filter
CancellationToken cancellationToken
Returns
Type Description
bool

ContainsSyntaxTree(SyntaxTree)

Declaration
public bool ContainsSyntaxTree(SyntaxTree syntaxTree)
Parameters
Type Name Description
SyntaxTree syntaxTree
Returns
Type Description
bool

CreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string>, ImmutableArray<bool>, ImmutableArray<Location>)

Declaration
public INamedTypeSymbol CreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol> memberTypes, ImmutableArray<string> memberNames, ImmutableArray<bool> memberIsReadOnly, ImmutableArray<Location> memberLocations)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> memberTypes
ImmutableArray<string> memberNames
ImmutableArray<bool> memberIsReadOnly
ImmutableArray<Location> memberLocations
Returns
Type Description
INamedTypeSymbol

CreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string>, ImmutableArray<bool>, ImmutableArray<Location>, ImmutableArray<NullableAnnotation>)

Declaration
public INamedTypeSymbol CreateAnonymousTypeSymbol(ImmutableArray<ITypeSymbol> memberTypes, ImmutableArray<string> memberNames, ImmutableArray<bool> memberIsReadOnly = default, ImmutableArray<Location> memberLocations = default, ImmutableArray<NullableAnnotation> memberNullableAnnotations = default)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> memberTypes
ImmutableArray<string> memberNames
ImmutableArray<bool> memberIsReadOnly
ImmutableArray<Location> memberLocations
ImmutableArray<NullableAnnotation> memberNullableAnnotations
Returns
Type Description
INamedTypeSymbol

CreateArrayTypeSymbol(ITypeSymbol, int)

Declaration
public IArrayTypeSymbol CreateArrayTypeSymbol(ITypeSymbol elementType, int rank)
Parameters
Type Name Description
ITypeSymbol elementType
int rank
Returns
Type Description
IArrayTypeSymbol

CreateArrayTypeSymbol(ITypeSymbol, int, NullableAnnotation)

Declaration
public IArrayTypeSymbol CreateArrayTypeSymbol(ITypeSymbol elementType, int rank = 1, NullableAnnotation elementNullableAnnotation = NullableAnnotation.None)
Parameters
Type Name Description
ITypeSymbol elementType
int rank
NullableAnnotation elementNullableAnnotation
Returns
Type Description
IArrayTypeSymbol

CreateBuiltinOperator(string, ITypeSymbol, ITypeSymbol)

Declaration
public IMethodSymbol CreateBuiltinOperator(string name, ITypeSymbol returnType, ITypeSymbol operandType)
Parameters
Type Name Description
string name
ITypeSymbol returnType
ITypeSymbol operandType
Returns
Type Description
IMethodSymbol

CreateBuiltinOperator(string, ITypeSymbol, ITypeSymbol, ITypeSymbol)

Declaration
public IMethodSymbol CreateBuiltinOperator(string name, ITypeSymbol returnType, ITypeSymbol leftType, ITypeSymbol rightType)
Parameters
Type Name Description
string name
ITypeSymbol returnType
ITypeSymbol leftType
ITypeSymbol rightType
Returns
Type Description
IMethodSymbol

CreateDefaultWin32Resources(bool, bool, Stream?, Stream?)

Declaration
public Stream CreateDefaultWin32Resources(bool versionResource, bool noManifest, Stream? manifestContents, Stream? iconInIcoFormat)
Parameters
Type Name Description
bool versionResource
bool noManifest
Stream manifestContents
Stream iconInIcoFormat
Returns
Type Description
Stream

CreateErrorNamespaceSymbol(INamespaceSymbol, string)

Declaration
public INamespaceSymbol CreateErrorNamespaceSymbol(INamespaceSymbol container, string name)
Parameters
Type Name Description
INamespaceSymbol container
string name
Returns
Type Description
INamespaceSymbol

CreateErrorTypeSymbol(INamespaceOrTypeSymbol?, string, int)

Declaration
public INamedTypeSymbol CreateErrorTypeSymbol(INamespaceOrTypeSymbol? container, string name, int arity)
Parameters
Type Name Description
INamespaceOrTypeSymbol container
string name
int arity
Returns
Type Description
INamedTypeSymbol

CreateFunctionPointerTypeSymbol(ITypeSymbol, RefKind, ImmutableArray<ITypeSymbol>, ImmutableArray<RefKind>, SignatureCallingConvention, ImmutableArray<INamedTypeSymbol>)

Declaration
public IFunctionPointerTypeSymbol CreateFunctionPointerTypeSymbol(ITypeSymbol returnType, RefKind returnRefKind, ImmutableArray<ITypeSymbol> parameterTypes, ImmutableArray<RefKind> parameterRefKinds, SignatureCallingConvention callingConvention = SignatureCallingConvention.Default, ImmutableArray<INamedTypeSymbol> callingConventionTypes = default)
Parameters
Type Name Description
ITypeSymbol returnType
RefKind returnRefKind
ImmutableArray<ITypeSymbol> parameterTypes
ImmutableArray<RefKind> parameterRefKinds
SignatureCallingConvention callingConvention
ImmutableArray<INamedTypeSymbol> callingConventionTypes
Returns
Type Description
IFunctionPointerTypeSymbol

CreateNativeIntegerTypeSymbol(bool)

Declaration
public INamedTypeSymbol CreateNativeIntegerTypeSymbol(bool signed)
Parameters
Type Name Description
bool signed
Returns
Type Description
INamedTypeSymbol

CreatePointerTypeSymbol(ITypeSymbol)

Declaration
public IPointerTypeSymbol CreatePointerTypeSymbol(ITypeSymbol pointedAtType)
Parameters
Type Name Description
ITypeSymbol pointedAtType
Returns
Type Description
IPointerTypeSymbol

CreateTupleTypeSymbol(INamedTypeSymbol, ImmutableArray<string?>, ImmutableArray<Location?>)

Declaration
public INamedTypeSymbol CreateTupleTypeSymbol(INamedTypeSymbol underlyingType, ImmutableArray<string?> elementNames, ImmutableArray<Location?> elementLocations)
Parameters
Type Name Description
INamedTypeSymbol underlyingType
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
Returns
Type Description
INamedTypeSymbol

CreateTupleTypeSymbol(INamedTypeSymbol, ImmutableArray<string?>, ImmutableArray<Location?>, ImmutableArray<NullableAnnotation>)

Declaration
public INamedTypeSymbol CreateTupleTypeSymbol(INamedTypeSymbol underlyingType, ImmutableArray<string?> elementNames = default, ImmutableArray<Location?> elementLocations = default, ImmutableArray<NullableAnnotation> elementNullableAnnotations = default)
Parameters
Type Name Description
INamedTypeSymbol underlyingType
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
ImmutableArray<NullableAnnotation> elementNullableAnnotations
Returns
Type Description
INamedTypeSymbol

CreateTupleTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string?>, ImmutableArray<Location?>)

Declaration
public INamedTypeSymbol CreateTupleTypeSymbol(ImmutableArray<ITypeSymbol> elementTypes, ImmutableArray<string?> elementNames, ImmutableArray<Location?> elementLocations)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> elementTypes
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
Returns
Type Description
INamedTypeSymbol

CreateTupleTypeSymbol(ImmutableArray<ITypeSymbol>, ImmutableArray<string?>, ImmutableArray<Location?>, ImmutableArray<NullableAnnotation>)

Declaration
public INamedTypeSymbol CreateTupleTypeSymbol(ImmutableArray<ITypeSymbol> elementTypes, ImmutableArray<string?> elementNames = default, ImmutableArray<Location?> elementLocations = default, ImmutableArray<NullableAnnotation> elementNullableAnnotations = default)
Parameters
Type Name Description
ImmutableArray<ITypeSymbol> elementTypes
ImmutableArray<string> elementNames
ImmutableArray<Location> elementLocations
ImmutableArray<NullableAnnotation> elementNullableAnnotations
Returns
Type Description
INamedTypeSymbol

Emit(Stream, Stream?, Stream?, Stream?, IEnumerable<ResourceDescription>?, EmitOptions?, IMethodSymbol?, Stream?, IEnumerable<EmbeddedText>?, Stream?, CancellationToken)

Declaration
public EmitResult Emit(Stream peStream, Stream? pdbStream = null, Stream? xmlDocumentationStream = null, Stream? win32Resources = null, IEnumerable<ResourceDescription>? manifestResources = null, EmitOptions? options = null, IMethodSymbol? debugEntryPoint = null, Stream? sourceLinkStream = null, IEnumerable<EmbeddedText>? embeddedTexts = null, Stream? metadataPEStream = null, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Stream peStream
Stream pdbStream
Stream xmlDocumentationStream
Stream win32Resources
IEnumerable<ResourceDescription> manifestResources
EmitOptions options
IMethodSymbol debugEntryPoint
Stream sourceLinkStream
IEnumerable<EmbeddedText> embeddedTexts
Stream metadataPEStream
CancellationToken cancellationToken
Returns
Type Description
EmitResult

Emit(Stream, Stream?, Stream?, Stream?, IEnumerable<ResourceDescription>?, EmitOptions, IMethodSymbol?, Stream?, IEnumerable<EmbeddedText>?, CancellationToken)

Declaration
public EmitResult Emit(Stream peStream, Stream? pdbStream, Stream? xmlDocumentationStream, Stream? win32Resources, IEnumerable<ResourceDescription>? manifestResources, EmitOptions options, IMethodSymbol? debugEntryPoint, Stream? sourceLinkStream, IEnumerable<EmbeddedText>? embeddedTexts, CancellationToken cancellationToken)
Parameters
Type Name Description
Stream peStream
Stream pdbStream
Stream xmlDocumentationStream
Stream win32Resources
IEnumerable<ResourceDescription> manifestResources
EmitOptions options
IMethodSymbol debugEntryPoint
Stream sourceLinkStream
IEnumerable<EmbeddedText> embeddedTexts
CancellationToken cancellationToken
Returns
Type Description
EmitResult

EmitDifference(EmitBaseline, IEnumerable<SemanticEdit>, Func<ISymbol, bool>, Stream, Stream, Stream, ICollection<MethodDefinitionHandle>, CancellationToken)

Declaration
[Obsolete("UpdatedMethods is now part of EmitDifferenceResult, so you should use an overload that doesn't take it.")]
public EmitDifferenceResult EmitDifference(EmitBaseline baseline, IEnumerable<SemanticEdit> edits, Func<ISymbol, bool> isAddedSymbol, Stream metadataStream, Stream ilStream, Stream pdbStream, ICollection<MethodDefinitionHandle> updatedMethods, CancellationToken cancellationToken = default)
Parameters
Type Name Description
EmitBaseline baseline
IEnumerable<SemanticEdit> edits
Func<ISymbol, bool> isAddedSymbol
Stream metadataStream
Stream ilStream
Stream pdbStream
ICollection<MethodDefinitionHandle> updatedMethods
CancellationToken cancellationToken
Returns
Type Description
EmitDifferenceResult

EmitDifference(EmitBaseline, IEnumerable<SemanticEdit>, Func<ISymbol, bool>, Stream, Stream, Stream, CancellationToken)

Declaration
public EmitDifferenceResult EmitDifference(EmitBaseline baseline, IEnumerable<SemanticEdit> edits, Func<ISymbol, bool> isAddedSymbol, Stream metadataStream, Stream ilStream, Stream pdbStream, CancellationToken cancellationToken = default)
Parameters
Type Name Description
EmitBaseline baseline
IEnumerable<SemanticEdit> edits
Func<ISymbol, bool> isAddedSymbol
Stream metadataStream
Stream ilStream
Stream pdbStream
CancellationToken cancellationToken
Returns
Type Description
EmitDifferenceResult

EmitDifference(EmitBaseline, IEnumerable<SemanticEdit>, Stream, Stream, Stream, ICollection<MethodDefinitionHandle>, CancellationToken)

Declaration
[Obsolete("UpdatedMethods is now part of EmitDifferenceResult, so you should use an overload that doesn't take it.")]
public EmitDifferenceResult EmitDifference(EmitBaseline baseline, IEnumerable<SemanticEdit> edits, Stream metadataStream, Stream ilStream, Stream pdbStream, ICollection<MethodDefinitionHandle> updatedMethods, CancellationToken cancellationToken = default)
Parameters
Type Name Description
EmitBaseline baseline
IEnumerable<SemanticEdit> edits
Stream metadataStream
Stream ilStream
Stream pdbStream
ICollection<MethodDefinitionHandle> updatedMethods
CancellationToken cancellationToken
Returns
Type Description
EmitDifferenceResult

GetAssemblyOrModuleSymbol(MetadataReference)

Declaration
public ISymbol? GetAssemblyOrModuleSymbol(MetadataReference reference)
Parameters
Type Name Description
MetadataReference reference
Returns
Type Description
ISymbol

GetCompilationNamespace(INamespaceSymbol)

Declaration
public INamespaceSymbol? GetCompilationNamespace(INamespaceSymbol namespaceSymbol)
Parameters
Type Name Description
INamespaceSymbol namespaceSymbol
Returns
Type Description
INamespaceSymbol

GetDeclarationDiagnostics(CancellationToken)

Declaration
public abstract ImmutableArray<Diagnostic> GetDeclarationDiagnostics(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
ImmutableArray<Diagnostic>

GetDiagnostics(CancellationToken)

Declaration
public abstract ImmutableArray<Diagnostic> GetDiagnostics(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
ImmutableArray<Diagnostic>

GetEntryPoint(CancellationToken)

Declaration
public IMethodSymbol? GetEntryPoint(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
IMethodSymbol

GetMetadataReference(IAssemblySymbol)

Declaration
public MetadataReference? GetMetadataReference(IAssemblySymbol assemblySymbol)
Parameters
Type Name Description
IAssemblySymbol assemblySymbol
Returns
Type Description
MetadataReference

GetMethodBodyDiagnostics(CancellationToken)

Declaration
public abstract ImmutableArray<Diagnostic> GetMethodBodyDiagnostics(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
ImmutableArray<Diagnostic>

GetParseDiagnostics(CancellationToken)

Declaration
public abstract ImmutableArray<Diagnostic> GetParseDiagnostics(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
ImmutableArray<Diagnostic>

GetRequiredLanguageVersion(Diagnostic)

Declaration
public static string? GetRequiredLanguageVersion(Diagnostic diagnostic)
Parameters
Type Name Description
Diagnostic diagnostic
Returns
Type Description
string

GetSemanticModel(SyntaxTree, SemanticModelOptions)

Declaration
public SemanticModel GetSemanticModel(SyntaxTree syntaxTree, SemanticModelOptions options)
Parameters
Type Name Description
SyntaxTree syntaxTree
SemanticModelOptions options
Returns
Type Description
SemanticModel

GetSemanticModel(SyntaxTree, bool)

Declaration
public SemanticModel GetSemanticModel(SyntaxTree syntaxTree, bool ignoreAccessibility = false)
Parameters
Type Name Description
SyntaxTree syntaxTree
bool ignoreAccessibility
Returns
Type Description
SemanticModel

GetSpecialType(SpecialType)

Declaration
public INamedTypeSymbol GetSpecialType(SpecialType specialType)
Parameters
Type Name Description
SpecialType specialType
Returns
Type Description
INamedTypeSymbol

GetSymbolsWithName(Func<string, bool>, SymbolFilter, CancellationToken)

Declaration
public abstract IEnumerable<ISymbol> GetSymbolsWithName(Func<string, bool> predicate, SymbolFilter filter = SymbolFilter.TypeAndMember, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Func<string, bool> predicate
SymbolFilter filter
CancellationToken cancellationToken
Returns
Type Description
IEnumerable<ISymbol>

GetSymbolsWithName(string, SymbolFilter, CancellationToken)

Declaration
public abstract IEnumerable<ISymbol> GetSymbolsWithName(string name, SymbolFilter filter = SymbolFilter.TypeAndMember, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string name
SymbolFilter filter
CancellationToken cancellationToken
Returns
Type Description
IEnumerable<ISymbol>

GetTypeByMetadataName(string)

Declaration
public INamedTypeSymbol? GetTypeByMetadataName(string fullyQualifiedMetadataName)
Parameters
Type Name Description
string fullyQualifiedMetadataName
Returns
Type Description
INamedTypeSymbol

GetTypesByMetadataName(string)

Declaration
public ImmutableArray<INamedTypeSymbol> GetTypesByMetadataName(string fullyQualifiedMetadataName)
Parameters
Type Name Description
string fullyQualifiedMetadataName
Returns
Type Description
ImmutableArray<INamedTypeSymbol>

GetUnreferencedAssemblyIdentities(Diagnostic)

Declaration
public ImmutableArray<AssemblyIdentity> GetUnreferencedAssemblyIdentities(Diagnostic diagnostic)
Parameters
Type Name Description
Diagnostic diagnostic
Returns
Type Description
ImmutableArray<AssemblyIdentity>

GetUsedAssemblyReferences(CancellationToken)

Declaration
public abstract ImmutableArray<MetadataReference> GetUsedAssemblyReferences(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
ImmutableArray<MetadataReference>

HasImplicitConversion(ITypeSymbol?, ITypeSymbol?)

Declaration
public bool HasImplicitConversion(ITypeSymbol? fromType, ITypeSymbol? toType)
Parameters
Type Name Description
ITypeSymbol fromType
ITypeSymbol toType
Returns
Type Description
bool

IsSymbolAccessibleWithin(ISymbol, ISymbol, ITypeSymbol?)

Declaration
public bool IsSymbolAccessibleWithin(ISymbol symbol, ISymbol within, ITypeSymbol? throughType = null)
Parameters
Type Name Description
ISymbol symbol
ISymbol within
ITypeSymbol throughType
Returns
Type Description
bool

RemoveAllReferences()

Declaration
public Compilation RemoveAllReferences()
Returns
Type Description
Compilation

RemoveAllSyntaxTrees()

Declaration
public Compilation RemoveAllSyntaxTrees()
Returns
Type Description
Compilation

RemoveReferences(params MetadataReference[])

Declaration
public Compilation RemoveReferences(params MetadataReference[] references)
Parameters
Type Name Description
MetadataReference[] references
Returns
Type Description
Compilation

RemoveReferences(IEnumerable<MetadataReference>)

Declaration
public Compilation RemoveReferences(IEnumerable<MetadataReference> references)
Parameters
Type Name Description
IEnumerable<MetadataReference> references
Returns
Type Description
Compilation

RemoveSyntaxTrees(params SyntaxTree[])

Declaration
public Compilation RemoveSyntaxTrees(params SyntaxTree[] trees)
Parameters
Type Name Description
SyntaxTree[] trees
Returns
Type Description
Compilation

RemoveSyntaxTrees(IEnumerable<SyntaxTree>)

Declaration
public Compilation RemoveSyntaxTrees(IEnumerable<SyntaxTree> trees)
Parameters
Type Name Description
IEnumerable<SyntaxTree> trees
Returns
Type Description
Compilation

ReplaceReference(MetadataReference, MetadataReference?)

Declaration
public Compilation ReplaceReference(MetadataReference oldReference, MetadataReference? newReference)
Parameters
Type Name Description
MetadataReference oldReference
MetadataReference newReference
Returns
Type Description
Compilation

ReplaceSyntaxTree(SyntaxTree, SyntaxTree)

Declaration
public Compilation ReplaceSyntaxTree(SyntaxTree oldTree, SyntaxTree newTree)
Parameters
Type Name Description
SyntaxTree oldTree
SyntaxTree newTree
Returns
Type Description
Compilation

SupportsRuntimeCapability(RuntimeCapability)

Declaration
public bool SupportsRuntimeCapability(RuntimeCapability capability)
Parameters
Type Name Description
RuntimeCapability capability
Returns
Type Description
bool

SyntaxTreeCommonFeatures(IEnumerable<SyntaxTree>)

Declaration
protected static IReadOnlyDictionary<string, string> SyntaxTreeCommonFeatures(IEnumerable<SyntaxTree> trees)
Parameters
Type Name Description
IEnumerable<SyntaxTree> trees
Returns
Type Description
IReadOnlyDictionary<string, string>

ToMetadataReference(ImmutableArray<string>, bool)

Declaration
public abstract CompilationReference ToMetadataReference(ImmutableArray<string> aliases = default, bool embedInteropTypes = false)
Parameters
Type Name Description
ImmutableArray<string> aliases
bool embedInteropTypes
Returns
Type Description
CompilationReference

WithAssemblyName(string?)

Declaration
public Compilation WithAssemblyName(string? assemblyName)
Parameters
Type Name Description
string assemblyName
Returns
Type Description
Compilation

WithOptions(CompilationOptions)

Declaration
public Compilation WithOptions(CompilationOptions options)
Parameters
Type Name Description
CompilationOptions options
Returns
Type Description
Compilation

WithReferences(params MetadataReference[])

Declaration
public Compilation WithReferences(params MetadataReference[] newReferences)
Parameters
Type Name Description
MetadataReference[] newReferences
Returns
Type Description
Compilation

WithReferences(IEnumerable<MetadataReference>)

Declaration
public Compilation WithReferences(IEnumerable<MetadataReference> newReferences)
Parameters
Type Name Description
IEnumerable<MetadataReference> newReferences
Returns
Type Description
Compilation

WithScriptCompilationInfo(ScriptCompilationInfo?)

Declaration
public Compilation WithScriptCompilationInfo(ScriptCompilationInfo? info)
Parameters
Type Name Description
ScriptCompilationInfo info
Returns
Type Description
Compilation

Extension Methods