Update code generator to handle generic types and types with multiple '+' signs in them. #102

yaeldekel · 2018-05-09T18:09:45Z

The C# code generator needs to be able to handle types that are nested inside generic classes. It should also handle types that are nested in nested classes.

yaeldekel · 2018-05-09T18:11:23Z

Fixes #101

TomFinley · 2018-05-09T19:58:08Z

src/Microsoft.ML/Runtime/Internal/Tools/CSharpApiGenerator.cs

@@ -495,16 +495,56 @@ private void GenerateFooter(IndentingTextWriter writer)
            writer.WriteLine();
        }

-        static string GetSymbolFromType(Dictionary<string, string> typesSymbolTable, string fullTypeName, string currentNamespace)
+        static string GetSymbolFromType(Dictionary<string, string> typesSymbolTable, Type type, string currentNamespace)


static [](start = 8, length = 6)

While we're at it let's add an explicit access modifier... #Closed

TomFinley · 2018-05-09T20:03:09Z

src/Microsoft.ML/Runtime/Internal/Tools/CSharpApiGenerator.cs

+                {
+                    Contracts.AssertValue(genericTypes);
+                    fullTypeName = fullTypeName.Substring(0, bracketIndex);
+                }


This is some fairly elaborate string manipulation going on, the utility of which will be opaque to anyone not intimately familiar with how the .NET class naming system works, and that also does not understand the specific issues raised in issue #101 that requires its introduction. #Resolved

I have a feeling this is more complicated. For comparison, there's a similar case (maybe not exactly, but anyway): https://github.com/dotnet/orleans/blob/master/src/AdoNet/Orleans.Persistence.AdoNet/Storage/Provider/AdoNetGrainStorage.cs#L506. More laborius, but might be usable to extract this to a separate class/function and test a bit more. This is something that probably should be done in Orleans too, since there are similar needs. :)

Also perhaps interesting in case there's a possibility to refactor out commonalities and have a joint library: https://github.com/dotnet/orleans/blob/e78c7fa4ae302808ed30d71ebc14f1ef544a923e/src/Orleans.Core/AssemblyLoader/AssemblyLoader.cs. #Resolved

Hi Veikko, thanks for your suggestion and for the reference. This method definitely doesn't handle every possible case for a type name (for example, it does not handle the case where the nested class is also generic). Since it is a private method, I think that would be enough for handle the cases we need it to handle. I did add some comments though, to make it easier to handle new cases if the need arises. #Resolved

I might be tempted to insert a link though to the MSDN docs for this at the GetType, since we're attempting to read a (subset) of the language. Plus maybe document the limitations of this method.

Edit: um I'm blind, I see you already did that. :P

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

TomFinley · 2018-05-09T20:03:30Z

src/Microsoft.ML.Transforms/WhiteningTransform.cs

@@ -571,7 +571,7 @@ private static Float DotProduct(Float[] a, int aOffset, Float[] b, int[] indices

        private static class Mkl
        {
-            private const string DllName = "Microsoft.ML.MklImports.dll";
+            private const string DllName = "Microsoft.MachineLearning.MklImports.dll";


Microsoft.MachineLearning [](start = 44, length = 25)

Is this related to the issue raised?

Given that we decided on Microsoft.ML vs. the more verbose Microsoft.MachineLearning, should not that DLL change its name, rather than the other way around? #Resolved

I had the same question but I also feel this should be made as a separate change and we should open an issue for this.

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

codemzs · 2018-05-10T23:14:31Z

src/Microsoft.ML/Runtime/Internal/Tools/CSharpApiGenerator.cs

+            int backTickIndex = baseName.LastIndexOf('`');
+            int dotIndex = baseName.LastIndexOf('.');
+            if (backTickIndex < 0)
+                name += baseName.Substring(dotIndex + 1);


name += baseName.Substring(dotIndex + 1); [](start = 15, length = 42)

Can dotindex be -1?

If it somehow cannot be (e.g., I might expect that everything would at least have a namespace), we should add a nice little Contracts.Assert to document that..

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

I think not, because the full name always begins with the namespace.

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

codemzs · 2018-05-10T23:15:37Z

src/Microsoft.ML/Runtime/Internal/Tools/CSharpApiGenerator.cs

+                        name += string.Join("", splitNames);
+                    }
+                }
+            }


This is great, thanks for doing this. May be put an example of how a name is generated from this control flow.

codemzs · 2018-05-10T23:17:03Z

src/Microsoft.ML/Runtime/Internal/Tools/CSharpApiGenerator.cs


-            name += fullTypeName.Substring(fullTypeName.LastIndexOf(dim) + 1); ;
+            for (int i = 1; i < nestedNames.Length; i++)
+                name += nestedNames[i];


I'm assuming you are adding this to have unique names but I feel these names should go before the generated name and is it possible to only add them when we detect there is a name collision? We add them as needed and if we run out of them then we can add rolling numbers.

Added an example in the XML comment.

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

TomFinley

Thanks @yaeldekel for fixing code generation for these types.

glebuk

… '+' signs in them. (dotnet#102) * Handle generic types and types with multiple '+' signs in them. * Delete commented code. * Address PR comments. * Skip codegen unit test. * Add example to comment. * Assert that the full type name has a dot in it. * Trigger build.

Handle generic types and types with multiple '+' signs in them.

bd0148f

yaeldekel requested review from codemzs and eerhardt May 9, 2018 18:11

Delete commented code.

8886ab7

TomFinley reviewed May 9, 2018

View reviewed changes

yaeldMS added 2 commits May 10, 2018 11:06

Address PR comments.

01df6e8

Skip codegen unit test.

0c95eed

codemzs reviewed May 10, 2018

View reviewed changes

TomFinley approved these changes May 10, 2018

View reviewed changes

glebuk approved these changes May 10, 2018

View reviewed changes

yaeldMS added 3 commits May 10, 2018 16:49

Add example to comment.

a3ddef9

Assert that the full type name has a dot in it.

34f32af

Trigger build.

2eaae14

yaeldekel merged commit 2e732ea into dotnet:master May 11, 2018

yaeldekel deleted the codegen branch May 11, 2018 15:39

shauheen mentioned this pull request May 14, 2018

C# code generator should handle generic types. #101

Closed

ghost locked as resolved and limited conversation to collaborators Mar 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update code generator to handle generic types and types with multiple '+' signs in them. #102

Update code generator to handle generic types and types with multiple '+' signs in them. #102

yaeldekel commented May 9, 2018 •

edited

Loading

yaeldekel commented May 9, 2018

TomFinley May 9, 2018 •

edited by glebuk

Loading

TomFinley May 9, 2018 •

edited by yaeldekel

Loading

veikkoeeva May 10, 2018 •

edited by glebuk

Loading

yaeldekel May 10, 2018 •

edited by glebuk

Loading

TomFinley May 10, 2018 •

edited

Loading

TomFinley May 9, 2018 •

edited by glebuk

Loading

codemzs May 10, 2018

codemzs May 10, 2018

TomFinley May 10, 2018 •

edited

Loading

yaeldekel May 10, 2018

codemzs May 10, 2018

codemzs May 10, 2018

yaeldekel May 10, 2018

TomFinley left a comment •

edited

Loading

glebuk left a comment

Update code generator to handle generic types and types with multiple '+' signs in them. #102

Update code generator to handle generic types and types with multiple '+' signs in them. #102

Conversation

yaeldekel commented May 9, 2018 • edited Loading

yaeldekel commented May 9, 2018

TomFinley May 9, 2018 • edited by glebuk Loading

Choose a reason for hiding this comment

TomFinley May 9, 2018 • edited by yaeldekel Loading

Choose a reason for hiding this comment

veikkoeeva May 10, 2018 • edited by glebuk Loading

Choose a reason for hiding this comment

yaeldekel May 10, 2018 • edited by glebuk Loading

Choose a reason for hiding this comment

TomFinley May 10, 2018 • edited Loading

Choose a reason for hiding this comment

TomFinley May 9, 2018 • edited by glebuk Loading

Choose a reason for hiding this comment

codemzs May 10, 2018

Choose a reason for hiding this comment

codemzs May 10, 2018

Choose a reason for hiding this comment

TomFinley May 10, 2018 • edited Loading

Choose a reason for hiding this comment

yaeldekel May 10, 2018

Choose a reason for hiding this comment

codemzs May 10, 2018

Choose a reason for hiding this comment

codemzs May 10, 2018

Choose a reason for hiding this comment

yaeldekel May 10, 2018

Choose a reason for hiding this comment

TomFinley left a comment • edited Loading

Choose a reason for hiding this comment

glebuk left a comment

Choose a reason for hiding this comment

yaeldekel commented May 9, 2018 •

edited

Loading

TomFinley May 9, 2018 •

edited by glebuk

Loading

TomFinley May 9, 2018 •

edited by yaeldekel

Loading

veikkoeeva May 10, 2018 •

edited by glebuk

Loading

yaeldekel May 10, 2018 •

edited by glebuk

Loading

TomFinley May 10, 2018 •

edited

Loading

TomFinley May 9, 2018 •

edited by glebuk

Loading

TomFinley May 10, 2018 •

edited

Loading

TomFinley left a comment •

edited

Loading