Skip to content

Expose display option to add ! on non-nullable types #40519

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jcouv merged 2 commits into from
Jan 4, 2020
Merged

Expose display option to add ! on non-nullable types #40519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c902e82
Expose display option to add ! on non-nullable types
jcouv Dec 20, 2019
7f8ace4
Make the two flags independent
Jan 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Compilers/CSharp/Portable/SymbolDisplay/SymbolDisplayVisitor.Types.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ private bool ShouldAddNullableAnnotation(ITypeSymbol type)
break;

case CodeAnalysis.NullableAnnotation.NotAnnotated:
if (format.CompilerInternalOptions.IncludesOption(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier) &&
if (format.MiscellaneousOptions.IncludesOption(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier) &&
!type.IsValueType &&
(type as Symbols.PublicModel.TypeSymbol)?.UnderlyingTypeSymbol.IsTypeParameterDisallowingAnnotation() != true)
{
Expand Down Expand Up @@ -805,7 +805,7 @@ private void AddTypeParameterConstraints(ImmutableArray<ITypeSymbol> typeArgumen
break;

case CodeAnalysis.NullableAnnotation.NotAnnotated:
if (format.CompilerInternalOptions.IncludesOption(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier))
if (format.MiscellaneousOptions.IncludesOption(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier))
{
AddPunctuation(SyntaxKind.ExclamationToken);
}
Expand Down
6 changes: 4 additions & 2 deletions src/Compilers/CSharp/Portable/Symbols/Symbol.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,8 +813,10 @@ public virtual string GetDocumentationCommentXml(
}

private static readonly SymbolDisplayFormat s_debuggerDisplayFormat =
SymbolDisplayFormat.TestFormat.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);
SymbolDisplayFormat.TestFormat
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier
| SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);

internal virtual string GetDebuggerDisplay()
{
Expand Down
5 changes: 2 additions & 3 deletions src/Compilers/CSharp/Portable/Symbols/TypeWithAnnotations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ private TypeWithAnnotations(TypeSymbol defaultType, NullableAnnotation nullableA
internal static readonly SymbolDisplayFormat TestDisplayFormat = new SymbolDisplayFormat(
typeQualificationStyle: SymbolDisplayTypeQualificationStyle.NameAndContainingTypesAndNamespaces,
genericsOptions: SymbolDisplayGenericsOptions.IncludeTypeParameters,
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier,
compilerInternalOptions: SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier);
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier);

internal static TypeWithAnnotations Create(bool isNullableEnabled, TypeSymbol typeSymbol, bool isAnnotated = false)
{
Expand Down Expand Up @@ -305,7 +304,7 @@ public string ToDisplayString(SymbolDisplayFormat format = null)
return str + "?";
}
else if (NullableAnnotation.IsNotAnnotated() &&
format.CompilerInternalOptions.IncludesOption(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier) &&
format.MiscellaneousOptions.IncludesOption(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier) &&
(!HasType || (!Type.IsValueType && !Type.IsTypeParameterDisallowingAnnotation())))
{
return str + "!";
Expand Down
4 changes: 2 additions & 2 deletions src/Compilers/CSharp/Test/Emit/Attributes/AttributeTests_Nullable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3552,8 +3552,8 @@ public class Program
}

private static readonly SymbolDisplayFormat _displayFormat = SymbolDisplayFormat.TestFormat.
WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.UseSpecialTypes).
WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier);
WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.UseSpecialTypes).
WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);

private static void VerifyBytes(TypeWithAnnotations type, byte[] expectedPreviously, byte[] expectedNow, string expectedDisplay)
{
Expand Down
28 changes: 20 additions & 8 deletions src/Compilers/CSharp/Test/Semantic/Semantics/NullableReferenceTypesTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51036,6 +51036,7 @@ void M3(string?* x) {}
}

delegate string? D1();
delegate string D2();

interface I1<T>{}
interface I2<T>{}
Expand All @@ -51062,6 +51063,14 @@ class F : C<F?>, I1<C<B?>>, I2<C<B>?>
.ToDisplayString(new SymbolDisplayFormat(delegateStyle: SymbolDisplayDelegateStyle.NameAndSignature,
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)));

Assert.Equal("String D1()", compilation.GetTypeByMetadataName("D1")
.ToDisplayString(new SymbolDisplayFormat(delegateStyle: SymbolDisplayDelegateStyle.NameAndSignature,
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));

Assert.Equal("String! D2()", compilation.GetTypeByMetadataName("D2")
.ToDisplayString(new SymbolDisplayFormat(delegateStyle: SymbolDisplayDelegateStyle.NameAndSignature,
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));

var f = compilation.GetTypeByMetadataName("F");
Assert.Equal("C<F?>", f.BaseType().ToTestDisplayString());
Assert.Equal("I1<C<B?>>", f.Interfaces()[0].ToTestDisplayString());
Expand Down Expand Up @@ -70702,8 +70711,9 @@ void symbolValidator(ModuleSymbol m)
var f2 = (MethodSymbol)m.GlobalNamespace.GetMember("B.F2");
Assert.Equal("void B.F2<T2>(T2 t2) where T2 : class?", f2.ToDisplayString(SymbolDisplayFormat.TestFormat.WithGenericsOptions(SymbolDisplayFormat.TestFormat.GenericsOptions | SymbolDisplayGenericsOptions.IncludeTypeConstraints)));
Assert.Equal("void B.F2<T2>(T2 t2) where T2 : class", f2.ToDisplayString(SymbolDisplayFormat.TestFormat.WithGenericsOptions(SymbolDisplayFormat.TestFormat.GenericsOptions | SymbolDisplayGenericsOptions.IncludeTypeConstraints).
WithMiscellaneousOptions(SymbolDisplayFormat.TestFormatWithConstraints.MiscellaneousOptions &
(~SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier))));
WithMiscellaneousOptions(SymbolDisplayFormat.TestFormatWithConstraints.MiscellaneousOptions &
~(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier))));

TypeParameterSymbol t2 = f2.TypeParameters[0];
Assert.True(t2.ReferenceTypeConstraintIsNullable);
if (isSource)
Expand Down Expand Up @@ -86647,7 +86657,7 @@ void assertNonNullTypesContext(NullableContextOptions nullableContextOptions)
var comp = CreateCompilation(new[] { source }, options: compilationOptions);

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : class!", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : class!", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));
}
}

Expand All @@ -86666,7 +86676,7 @@ class A<T> where T :
var comp = CreateCompilation(new[] { source }, options: WithNonNullTypesTrue());

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : class", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : class", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));
}

[Fact]
Expand All @@ -86690,7 +86700,8 @@ void assertNonNullTypesContext(NullableContextOptions nullableContextOptions)
var comp = CreateCompilation(new[] { source }, options: compilationOptions);

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : class?", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : class?", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)));
Assert.Equal("A<T> where T : class", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));

comp.VerifyDiagnostics();
}
Expand All @@ -86711,7 +86722,8 @@ class A<T> where T : class
var comp = CreateCompilation(new[] { source }, options: WithNonNullTypesTrue());

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : class?", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : class?", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)));
Assert.Equal("A<T> where T : class", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));

comp.VerifyDiagnostics(
// (4,5): warning CS8632: The annotation for nullable reference types should only be used in code within a '#nullable' context.
Expand Down Expand Up @@ -86743,7 +86755,7 @@ void assertNonNullTypesContext(NullableContextOptions nullableContextOptions)
var comp = CreateCompilation(new[] { source }, options: compilationOptions);

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : unmanaged!", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : unmanaged!", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));
}
}

Expand All @@ -86764,7 +86776,7 @@ class unmanaged {}
var comp = CreateCompilation(new[] { source }, options: WithNonNullTypesTrue());

var a = comp.GetTypeByMetadataName("A`1");
Assert.Equal("A<T> where T : unmanaged", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)));
Assert.Equal("A<T> where T : unmanaged", a.ToDisplayString(SymbolDisplayFormat.TestFormatWithConstraints.WithMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)));
}

[Fact]
Expand Down
9 changes: 5 additions & 4 deletions src/Compilers/CSharp/Test/Symbol/SymbolDisplay/SymbolDisplayTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5287,8 +5287,8 @@ class B
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes | SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);

var formatWithNonNullableModifier = formatWithoutNonNullableModifier
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);

var method = comp.GetMember<IMethodSymbol>("B.F1");
Verify(
Expand Down Expand Up @@ -5359,7 +5359,8 @@ class B
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes);

var formatWithNullableModifier = formatWithoutNullableModifier
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);

var method = comp.GetMember<IMethodSymbol>("B.F1");
Verify(
Expand Down Expand Up @@ -5424,7 +5425,7 @@ class C
memberOptions: SymbolDisplayMemberOptions.IncludeType | SymbolDisplayMemberOptions.IncludeModifiers,
miscellaneousOptions: SymbolDisplayMiscellaneousOptions.UseSpecialTypes);
var formatWithNullableModifier = formatWithoutModifiers.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);
var formatWithBothModifiers = formatWithNullableModifier.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier);
var formatWithBothModifiers = formatWithNullableModifier.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier);

var member = comp.GetMember("C.F1");
Verify(
Expand Down
1 change: 1 addition & 0 deletions src/Compilers/Core/Portable/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Microsoft.CodeAnalysis.SarifVersion.Latest = 2147483647 -> Microsoft.CodeAnalysi
Microsoft.CodeAnalysis.SarifVersion.Sarif1 = 1 -> Microsoft.CodeAnalysis.SarifVersion
Microsoft.CodeAnalysis.SarifVersion.Sarif2 = 2 -> Microsoft.CodeAnalysis.SarifVersion
Microsoft.CodeAnalysis.SarifVersionFacts
Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier = 256 -> Microsoft.CodeAnalysis.SymbolDisplayMiscellaneousOptions
static Microsoft.CodeAnalysis.SarifVersionFacts.TryParse(string version, out Microsoft.CodeAnalysis.SarifVersion result) -> bool
Microsoft.CodeAnalysis.IMethodSymbol.IsConditional.get -> bool
Microsoft.CodeAnalysis.Operations.IForEachLoopOperation.IsAsynchronous.get -> bool
Expand Down
9 changes: 1 addition & 8 deletions src/Compilers/Core/Portable/SymbolDisplay/SymbolDisplayCompilerInternalOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,9 @@ internal enum SymbolDisplayCompilerInternalOptions
/// </summary>
ReverseArrayRankSpecifiers = 1 << 5,

/// <summary>
/// Append '!' to non-nullable reference types.
/// Note this causes SymbolDisplay to pull on IsNullable and therefore NonNullTypes,
/// so don't use this option in binding, in order to avoid cycles.
/// </summary>
IncludeNonNullableTypeModifier = 1 << 6,

/// <summary>
/// Display `System.ValueTuple` instead of tuple syntax `(...)`.
/// </summary>
UseValueTuple = 1 << 7,
UseValueTuple = 1 << 6,
}
}
7 changes: 2 additions & 5 deletions src/Compilers/Core/Portable/SymbolDisplay/SymbolDisplayFormat.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,8 @@ public class SymbolDisplayFormat
/// A verbose format for displaying symbols (useful for testing).
/// </summary>
internal static readonly SymbolDisplayFormat TestFormatWithConstraints = TestFormat.WithGenericsOptions(TestFormat.GenericsOptions | SymbolDisplayGenericsOptions.IncludeTypeConstraints).
WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier);
AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier).
WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);

/// <summary>
/// this.QualifiedNameOnly = containingSymbol.QualifiedNameOnly + "." + this.Name
Expand Down Expand Up @@ -403,10 +404,6 @@ internal SymbolDisplayFormat(
SymbolDisplayKindOptions kindOptions = default(SymbolDisplayKindOptions),
SymbolDisplayMiscellaneousOptions miscellaneousOptions = default(SymbolDisplayMiscellaneousOptions))
{
// If we want to display `!`, then we surely also want to display `?`
Debug.Assert(miscellaneousOptions.IncludesOption(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)
|| !compilerInternalOptions.IncludesOption(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier));

this.GlobalNamespaceStyle = globalNamespaceStyle;
this.TypeQualificationStyle = typeQualificationStyle;
this.GenericsOptions = genericsOptions;
Expand Down
5 changes: 5 additions & 0 deletions src/Compilers/Core/Portable/SymbolDisplay/SymbolDisplayMiscellaneousOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,10 @@ public enum SymbolDisplayMiscellaneousOptions
/// Allow the use of <c>default</c> instead of <c>default(T)</c> where applicable.
/// </summary>
AllowDefaultLiteral = 1 << 7,

/// <summary>
/// Append '!' to non-nullable reference types.
/// </summary>
IncludeNonNullableReferenceTypeModifier = 1 << 8,
}
}
3 changes: 1 addition & 2 deletions src/Compilers/Test/Utilities/CSharp/CSharpTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1067,8 +1067,7 @@ internal static void VerifyUsesOfNullability(Symbol symbol, ImmutableArray<strin
UsesIsNullableVisitor.GetUses(builder, symbol);

var format = SymbolDisplayFormat.TestFormat
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier)
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier)
.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier | SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)
.RemoveParameterOptions(SymbolDisplayParameterOptions.IncludeName);

var symbols = builder.SelectAsArray(s => s.ToDisplayString(format));
Expand Down
3 changes: 2 additions & 1 deletion src/Compilers/Test/Utilities/CSharp/SymbolUtilities.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ private static SymbolDisplayFormat GetDisplayFormat(bool includeNonNullable)
var format = SymbolDisplayFormat.TestFormat;
if (includeNonNullable)
{
format = format.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.IncludeNonNullableTypeModifier);
format = format.AddMiscellaneousOptions(SymbolDisplayMiscellaneousOptions.IncludeNonNullableReferenceTypeModifier)
.WithCompilerInternalOptions(SymbolDisplayCompilerInternalOptions.None);
}

return format;
Expand Down