Record-structs: address misc other IDE scenarios #52464

jcouv · 2021-04-07T15:33:18Z

~~Ignore the first commit (comes from previous PR).~~
Test plan: #51199

jcouv · 2021-04-07T15:36:19Z

src/EditorFeatures/CSharp/CompleteStatement/CompleteStatementCommandHandler.cs

@@ -392,8 +392,12 @@ private static bool SemicolonIsMissing(SyntaxNode currentNode)
 return ((ExternAliasDirectiveSyntax)currentNode).SemicolonToken.IsMissing;
 case SyntaxKind.ClassDeclaration:
 return ((ClassDeclarationSyntax)currentNode).SemicolonToken.IsMissing;
+ case SyntaxKind.RecordDeclaration:
+ return ((RecordDeclarationSyntax)currentNode).SemicolonToken.IsMissing;


📝 I did a search for usage of StructDeclaration and IsRecord and added cases for records and record structs if missing.
But some of them I was not able to cover with test. I'll call them out. This is one of them. #Resolved

@jcouv This private method is unused. That's why it's not covered by a test.

I had a PR in the past to remove it (#48098), but it hadn't got merged yet. #Resolved

jcouv · 2021-04-07T15:37:30Z

src/EditorFeatures/CSharpTest/MakeRefStruct/MakeRefStructTests.cs

+ public async Task FieldInRecordStruct()
+ {
+ var text = CreateTestSource(@"
+record struct S


📝 The language doesn't allow record and ref struct together. #Resolved

interesting. i'm curious why not. #Resolved

in other words, was this an intentional omission, or we just didnt' consider it. #Resolved

We considered it and rejected it.
The main rationale is that ref structs can't be used as type parameter, so IEquatable<RefStruct> and generic code we produce for equality comparison isn't possible.

In reply to: 609207949 [](ancestors = 609207949)

src/Workspaces/CSharp/Portable/CodeGeneration/CSharpDeclarationComparer.cs

jcouv · 2021-04-07T15:56:03Z

src/Workspaces/CSharp/Portable/CodeGeneration/NamedTypeGenerator.cs

+ }
+ else
+ {
+ typeDeclaration = SyntaxFactory.RecordStructDeclaration(SyntaxFactory.Token(SyntaxKind.RecordKeyword), namedType.Name.ToIdentifierToken());


📝 not tested (we don't yet have scenarios to generate record structs, but implementation is straightforward #Resolved

i think we'll be fine. i'm going to write a feature to covert a tuple to a named record. So i'll test it that way. #Resolved

src/EditorFeatures/Core.Wpf/Classification/ClassificationTypeFormatDefinitions.cs

RikkiGibson · 2021-04-07T16:58:21Z

...es/CSharp/Portable/Completion/CompletionProviders/ExplicitInterfaceTypeCompletionProvider.cs

- => node.Kind() == SyntaxKind.ClassDeclaration || node.Kind() == SyntaxKind.StructDeclaration ||
- node.Kind() == SyntaxKind.InterfaceDeclaration || node.Kind() == SyntaxKind.RecordDeclaration;
+ => node.IsKind(SyntaxKind.ClassDeclaration) || node.IsKind(SyntaxKind.StructDeclaration) ||
+ node.IsKind(SyntaxKind.InterfaceDeclaration) || node.IsKind(SyntaxKind.RecordDeclaration) || node.IsKind(SyntaxKind.RecordStructDeclaration);
 }


Was this change intended to be included in the PR? #Resolved

Yes, I made the change intentionally. #Resolved

RikkiGibson · 2021-04-07T16:59:55Z

src/Features/CSharp/Portable/Completion/KeywordRecommenders/ReadOnlyKeywordRecommender.cs

- => context.ContainingTypeDeclaration.IsKind(SyntaxKind.StructDeclaration) &&
+ {
+ var type = context.ContainingTypeDeclaration;
+ return (type.IsKind(SyntaxKind.StructDeclaration) || type.IsKind(SyntaxKind.RecordStructDeclaration)) &&


nit: I think there's precedent to use or when there are multiple acceptable kinds. Alternatively I believe IsKind is overloaded with various numbers of parameters.

type.Kind() is SyntaxKind.StructDeclaration or SyntaxKind.RecordStructDeclaration #Pending

yes. we're switching these to use or. it's esp nice as precedence is clear. i.e. you dn't need to parenthesize as the or and the && don't mix :) #Pending

RikkiGibson · 2021-04-07T17:49:45Z

src/Workspaces/Core/Portable/CodeGeneration/Symbols/CodeGenerationTypeSymbol.cs

@@ -38,7 +38,7 @@ public virtual ImmutableArray<INamedTypeSymbol> Interfaces
 public ImmutableArray<INamedTypeSymbol> AllInterfaces
 => ImmutableArray.Create<INamedTypeSymbol>();

- public bool IsReferenceType => false;
+ public bool IsReferenceType => TypeKind == TypeKind.Class;


Which scenario is affected by this change?

Should this method return 'true' if TypeKind is Interface, for example? #Resolved

I'll adjust.
Elsewhere in code generators I made a change that adds a check for IsReferenceType. That code relied on a cast to RecordDeclarationSyntax which would obviously break. #Resolved

RikkiGibson · 2021-04-07T17:51:44Z

src/Workspaces/CSharp/Portable/CodeGeneration/NamedTypeGenerator.cs

@@ -196,7 +198,14 @@ private static MemberDeclarationSyntax RemoveAllMembers(MemberDeclarationSyntax
 TypeDeclarationSyntax typeDeclaration;
 if (namedType.IsRecord)
 {
- typeDeclaration = SyntaxFactory.RecordDeclaration(SyntaxFactory.Token(SyntaxKind.RecordKeyword), namedType.Name.ToIdentifierToken());
+ if (namedType.IsReferenceType)


nit: consider pushing this down into a conditional expression that assigns to typeDeclaration #Pending

yes. plz do this. #Pending

jcouv · 2021-04-07T18:40:36Z

src/Features/CSharp/Portable/Organizing/Organizers/MemberDeclarationsOrganizer.Comparer.cs

@@ -171,6 +171,7 @@ private static OuterOrdering GetOuterOrdering(MemberDeclarationSyntax x)
 case SyntaxKind.EnumDeclaration:
 case SyntaxKind.DelegateDeclaration:
 case SyntaxKind.RecordDeclaration:
+ case SyntaxKind.RecordStructDeclaration:


📝 not tested. I couldn't find test impacted by some cases above and am not familiar with organizers in general. #Resolved

we haven't shipped this. so no tests needed. #Resolved

CyrusNajmabadi · 2021-04-08T02:04:19Z

src/EditorFeatures/CSharpTest/CodeActions/ExtractMethod/ExtractMethodTests.cs

 {
 int field;

 public int this[int i] => {|Rename:GetField|}();

- private int GetField()
+ private readonly int GetField()


interesting. i didn't know we did that. #Resolved

CyrusNajmabadi · 2021-04-08T02:04:52Z

src/EditorFeatures/CSharpTest/CodeLens/CSharpCodeLensTests.cs

+ [Theory, Trait(Traits.Feature, Traits.Features.CodeLens)]
+ [InlineData("class", "class", "class")]
+ [InlineData("record class", "record class", "record class")]
+ [InlineData("record struct", "record struct", "record struct")]


i don't get the need for triplicate (since they're all the same). why not just pass in one, and reference hte paramter three times? #Pending

Initially I thought I'd include some mix&match combinations, but it wasn't necessary to hit the cases I wanted. I'll simplify

In reply to: 609207610 [](ancestors = 609207610)

CyrusNajmabadi · 2021-04-08T02:06:13Z

src/EditorFeatures/CSharpTest/Organizing/OrganizeTypeDeclarationTests.cs

@@ -24,6 +24,8 @@ public class OrganizeTypeDeclarationTests : AbstractOrganizerTests
 [Theory, Trait(Traits.Feature, Traits.Features.Organizing)]
 [InlineData("class")]
 [InlineData("record")]
+ [InlineData("record class")]
+ [InlineData("record struct")]
 public async Task TestFieldsWithoutInitializers1(string typeKind)


the most tested feature we're not even shipping :D

CyrusNajmabadi · 2021-04-08T02:07:13Z

src/EditorFeatures/Core/Implementation/Classification/ClassificationTypeDefinitions.cs

+ #region User Types - Record Structs
+ [Export]
+ [Name(ClassificationTypeNames.RecordStructName)]
+ [BaseDefinition(ClassificationTypeNames.StructName)]


interesting base-definition. i would honestly expect .FormatLanguage here. but i suppose this won't hurt :)

Looking at the history, for the corresponding record class case, it started as FormatLanguage, but then got changed to ClassName.
I have no opinion (first time touching this)

In reply to: 609208508 [](ancestors = 609208508)

CyrusNajmabadi · 2021-04-08T02:09:22Z

src/Features/CSharp/Portable/GenerateType/CSharpGenerateTypeService.cs

@@ -673,7 +671,7 @@ internal override bool TryGetBaseList(ExpressionSyntax expression, out TypeKindO
 {
 if (node is BaseListSyntax)
 {
- if (node.Parent != null && (node.Parent is InterfaceDeclarationSyntax || node.Parent is StructDeclarationSyntax))
+ if (node.Parent != null && (node.Parent is InterfaceDeclarationSyntax or StructDeclarationSyntax or RecordStructDeclarationSyntax))


Suggested change

if (node.Parent != null && (node.Parent is InterfaceDeclarationSyntax or StructDeclarationSyntax or RecordStructDeclarationSyntax))

if (node.Parent is InterfaceDeclarationSyntax or StructDeclarationSyntax or RecordStructDeclarationSyntax)

``` #Pending

CyrusNajmabadi · 2021-04-08T02:10:30Z

src/Features/CSharp/Portable/Structure/CSharpStructureHelpers.cs

 else if (node.IsKind(SyntaxKind.ClassDeclaration, out TypeDeclarationSyntax typeDeclaration)
 || node.IsKind(SyntaxKind.RecordDeclaration, out typeDeclaration)
+ || node.IsKind(SyntaxKind.RecordStructDeclaration, out typeDeclaration)
 || node.IsKind(SyntaxKind.StructDeclaration, out typeDeclaration)
 || node.IsKind(SyntaxKind.InterfaceDeclaration, out typeDeclaration))


Suggested change

else if (node.IsKind(SyntaxKind.ClassDeclaration, out TypeDeclarationSyntax typeDeclaration)

|| node.IsKind(SyntaxKind.RecordDeclaration, out typeDeclaration)

|| node.IsKind(SyntaxKind.RecordStructDeclaration, out typeDeclaration)

|| node.IsKind(SyntaxKind.StructDeclaration, out typeDeclaration)

|| node.IsKind(SyntaxKind.InterfaceDeclaration, out typeDeclaration))

else if (node is TypeDeclarationSyntax typeDeclaration)

Not sure why we have so many patterns to express things that are trivial language checks :) #Pending

CyrusNajmabadi · 2021-04-08T02:10:56Z

src/Features/CSharp/Portable/Structure/CSharpStructureHelpers.cs

@@ -373,6 +374,7 @@ static SyntaxToken GetHintTextEndToken(SyntaxNode node)
 }
 else if (node.IsKind(SyntaxKind.ClassDeclaration, out TypeDeclarationSyntax typeDeclaration)
 || node.IsKind(SyntaxKind.RecordDeclaration, out typeDeclaration)
+ || node.IsKind(SyntaxKind.RecordStructDeclaration, out typeDeclaration)
 || node.IsKind(SyntaxKind.StructDeclaration, out typeDeclaration)
 || node.IsKind(SyntaxKind.InterfaceDeclaration, out typeDeclaration))
 {


same here. #Pending

CyrusNajmabadi · 2021-04-08T02:12:36Z

src/Workspaces/CSharp/Portable/CodeGeneration/NamedTypeGenerator.cs

@@ -79,7 +79,7 @@ internal static class NamedTypeGenerator

 var members = GetMembers(namedType).Where(s => s.Kind != SymbolKind.Property || PropertyGenerator.CanBeGenerated((IPropertySymbol)s))
 .ToImmutableArray();
- if (namedType.IsRecord)
+ if (namedType.IsRecord && namedType.IsReferenceType)


i wouldn't make this change. looking at the code it looks like it would handle struct records jsut fine. #Resolved

I made the change because of the cast below which would crash for record structs. Record structs use RecordStructDeclarationSyntax which derives from TypeDeclarationSyntax but isn't related to RecordDeclarationSyntax.

In reply to: 609211082 [](ancestors = 609211082)

CyrusNajmabadi

thanks! minor nits. up to you on handling them.

jcouv · 2021-04-08T04:26:03Z

This PR is waiting for #52455 to be merged first. Marking as Blocked

Youssef1313 · 2021-04-08T04:55:19Z

src/Workspaces/Core/Portable/CodeGeneration/Symbols/CodeGenerationTypeSymbol.cs

@@ -38,7 +38,7 @@ public virtual ImmutableArray<INamedTypeSymbol> Interfaces
 public ImmutableArray<INamedTypeSymbol> AllInterfaces
 => ImmutableArray.Create<INamedTypeSymbol>();

- public bool IsReferenceType => false;
+ public bool IsReferenceType => TypeKind != TypeKind.Enum && TypeKind != TypeKind.Struct && TypeKind != TypeKind.Error;


Unless there is a reason for the need of this change, I'd keep it as is, and use TypeKind.Class in the places IsReferenceType is used in this PR. It's always used as a second condition for "IsRecord", so we know for sure it's either a class or a struct.

I also believe IsRecord is checked along with TypeKind in the compiler layer, so that will be consistent as well. #Resolved

I can live with that ;-)

In reply to: 609297016 [](ancestors = 609297016)

jcouv · 2021-04-08T21:38:54Z

Rebased to remove the first commit (since merged as part of another PR)

jcouv · 2021-04-09T06:48:14Z

src/EditorFeatures/Test2/IntelliSense/IntellisenseQuickInfoBuilderTests.vb

+ New ClassifiedTextRun(ClassificationTypeNames.WhiteSpace, " "),
+ New ClassifiedTextRun(ClassificationTypeNames.Text, "1"),
+ New ClassifiedTextRun(ClassificationTypeNames.WhiteSpace, " "),
+ New ClassifiedTextRun(ClassificationTypeNames.Text, "overload"),


@CyrusNajmabadi @sharwell FYI this test was failing in Spanish CI leg because of "overload" in New ClassifiedTextRun(ClassificationTypeNames.Text, "overload").
I'ved fixed it, but noticed that other tests in this file hardcode "overloads". Does that mean we have a localization problem? (I'd expect those tests to fail in Spanish too)

I can't see a reason why the other tests don't fail.

Both "overload" and "overloads" resources are localized in Spanish.

roslyn/src/Features/Core/Portable/xlf/FeaturesResources.es.xlf

Lines 2633 to 2642 in be8f790

<trans-unit id="overload">

<source>overload</source>

<target state="translated">sobrecarga</target>

<note />

</trans-unit>

<trans-unit id="overloads_">

<source>overloads</source>

<target state="translated">sobrecargas</target>

<note />

</trans-unit>

jcouv added Area-IDE New Language Feature - Records Records labels Apr 7, 2021

jcouv self-assigned this Apr 7, 2021

jcouv requested review from a team as code owners April 7, 2021 15:33

jcouv commented Apr 7, 2021

View reviewed changes

src/Workspaces/CSharp/Portable/CodeGeneration/CSharpDeclarationComparer.cs Show resolved Hide resolved

jcouv commented Apr 7, 2021

View reviewed changes

src/EditorFeatures/Core.Wpf/Classification/ClassificationTypeFormatDefinitions.cs Show resolved Hide resolved

RikkiGibson approved these changes Apr 7, 2021

View reviewed changes

jcouv commented Apr 7, 2021

View reviewed changes

CyrusNajmabadi reviewed Apr 8, 2021

View reviewed changes

CyrusNajmabadi approved these changes Apr 8, 2021

View reviewed changes

jcouv added the Blocked label Apr 8, 2021

Youssef1313 mentioned this pull request Apr 8, 2021

Delete unused private method #48098

Closed

Youssef1313 reviewed Apr 8, 2021

View reviewed changes

jcouv added 4 commits April 8, 2021 14:38

Address misc other IDE scenarios

773ca8b

Add tests

20712c8

Remove dead code

7895d08

tweaks

51cc489

jcouv added 2 commits April 8, 2021 14:38

Address feedback

53b3532

Use TypeKind

c86b23e

jcouv force-pushed the rs-ide branch from cb6910f to c86b23e Compare April 8, 2021 21:38

jcouv removed the Blocked label Apr 9, 2021

jcouv enabled auto-merge (squash) April 9, 2021 01:00

localize test for spanish CI branch

08ca997

jcouv merged commit 99ee4b4 into dotnet:features/record-structs Apr 9, 2021

jcouv deleted the rs-ide branch April 9, 2021 06:44

jcouv commented Apr 9, 2021

View reviewed changes

	if (node.Parent != null && (node.Parent is InterfaceDeclarationSyntax or StructDeclarationSyntax or RecordStructDeclarationSyntax))
	if (node.Parent is InterfaceDeclarationSyntax or StructDeclarationSyntax or RecordStructDeclarationSyntax)
	``` #Pending

	<trans-unit id="overload">
	<source>overload</source>
	<target state="translated">sobrecarga</target>
	<note />
	</trans-unit>
	<trans-unit id="overloads_">
	<source>overloads</source>
	<target state="translated">sobrecargas</target>
	<note />
	</trans-unit>

Record-structs: address misc other IDE scenarios #52464

Record-structs: address misc other IDE scenarios #52464

Conversation

jcouv commented Apr 7, 2021 • edited Loading

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

Youssef1313 Apr 7, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

RikkiGibson Apr 7, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

RikkiGibson Apr 7, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

RikkiGibson Apr 7, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

RikkiGibson Apr 7, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

jcouv Apr 7, 2021 • edited Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

CyrusNajmabadi Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CyrusNajmabadi left a comment

Choose a reason for hiding this comment

jcouv commented Apr 8, 2021

Youssef1313 Apr 8, 2021 • edited by jcouv Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcouv commented Apr 8, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jcouv commented Apr 7, 2021 •

edited

Loading

jcouv Apr 7, 2021 •

edited

Loading

Youssef1313 Apr 7, 2021 •

edited by jcouv

Loading

jcouv Apr 7, 2021 •

edited

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

jcouv Apr 7, 2021 •

edited

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

RikkiGibson Apr 7, 2021 •

edited by jcouv

Loading

jcouv Apr 7, 2021 •

edited

Loading

RikkiGibson Apr 7, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

RikkiGibson Apr 7, 2021 •

edited by jcouv

Loading

jcouv Apr 7, 2021 •

edited

Loading

RikkiGibson Apr 7, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

jcouv Apr 7, 2021 •

edited

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

CyrusNajmabadi Apr 8, 2021 •

edited by jcouv

Loading

Youssef1313 Apr 8, 2021 •

edited by jcouv

Loading