[generator] Only skip generic "overloads" of bound types (#178)

Fixes: https://bugzilla.xamarin.com/show_bug.cgi?id=57828
The #runtime team is attempting to update xamarin-android to use the
[mono/2017-06][0] and [mono/2017-08][1] (and...) branches, and when
doing so they are seeing a unit test fail in
`Xamarin.Android.Build.Tests.BuildTest.GeneratorValidateMultiMethodEventName()`:
no `BG850*` warnings are expected but they are produced.
After much analysis, the cause of ght `BG850*` warnings is that
the mono/2017-06 branch introduces a non-generic "overload" of
`System.Collections.Generic.KeyValuePair`:
namespace System.Collections.Generic {
// New with mono/2017-06
partial class KeyValuePair {
public static KeyValuePair<TKey, TValue> Create<TKey, TValue>(TKey key, TValue value);
}
// Existing since forever
partial struct KeyValuePair<TKey, TValue> {
}
}
Specifically, the above "`KeyValuePair` overload" type runs into a
FIXME within `CodeGenerator.cs`:
// FIXME: at some stage we want to import generic types.
// For now generator fails to load generic types that have conflicting type e.g.
// AdapterView`1 and AdapterView cannot co-exist.
// It is mostly because generator primarily targets jar (no real generics land).
The *intent* of the check that is that, given a type `AdapterView<T>`,
we only check to see if `AdapterView` exists as well. If it does exist,
then we *ignore* the `AdapterView<T>` type, and only use the
`AdapterView` type for code generation.
In the case of `KeyValuePair`, the same "check" is done, which cause
us to *skip* type registration for `KeyValuePair<TKey, TValue>`, which
in turn causes us to invalidate e.g. `IDictionary<TKey, TValue>` -- as
it implements `ICollection<KeyValuePair<TKey, TValue>>` -- and
everything promply falls apart from there:
warning BG8C00: For type System.Collections.Generic.IDictionary`2, base interface System.Collections.Generic.ICollection`1<System.Collections.Generic.KeyValuePair`2<TKey,TValue>> is invalid.
warning BG8C00: For type System.Collections.Generic.IDictionary`2, base interface System.Collections.Generic.IEnumerable`1<System.Collections.Generic.KeyValuePair`2<TKey,TValue>> is invalid.
warning BG8502: Invalidating System.Collections.Generic.IDictionary`2 and all nested types because some of its interfaces were invalid.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.String,System.Collections.Generic.IList`1<System.String>> in method MapEquivalents in managed type Java.Util.Locale.LanguageRange.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.String,System.Collections.Generic.IList`1<System.String>> in method Parse in managed type Java.Util.Locale.LanguageRange.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.String,System.Object> in method NewFileSystem in managed type Java.Nio.FileNio.Spi.FileSystemProvider.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.String,System.Object> in method NewFileSystem in managed type Java.Nio.FileNio.Spi.FileSystemProvider.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.String,System.String> in method .ctor in managed type Java.Security.Provider.Service.
warning BG8801: Invalid parameter type System.Collections.Generic.IDictionary`2<System.Object,System.Object> in method PutAll in managed type Java.Security.Provider.
I still don't fully understand the scenario that the check was
attempting to solve, so in lieu of actually fixing the FIXME, make the
check *stricter* so that we only ignore "generically overloaded" types
if they bind the *same* Java type. Since `KeyValuePair<TKey, TValue>`
binds *no* Java type, it will no longer be skipped, thus removing the
BG8502 and related warnings.
Additionally, a bit of code cleanup for consistency: some parts of the
code use `HAVE_CECIL`, and others use `USE_CECIL`. Standardize on
`HAVE_CECIL` for consistency and sanity.
[0]: dotnet/android#631
[1]: dotnet/android#723

Author: jonpryor

src/Java.Interop.Tools.TypeNameMappings/Java.Interop.Tools.TypeNameMappings/JniType.cs

@@ -9,8 +9,8 @@
 #if HAVE_CECIL
 usingMono.Cecil;
 usingJava.Interop.Tools.Cecil;
-#if !GENERATOR
 usingAndroid.Runtime;
+#if !GENERATOR
 usingJava.Interop.Tools.JavaCallableWrappers;
 #endif // !GENERATOR
 #endif // HAVE_CECIL
@@ -252,7 +252,7 @@ static string GetSpecialExportJniType (string typeName, ExportParameterKind expo
 returnnull;
 }
 
-#if !GEN_JAVA_STUBS&&!GENERATOR&&!JAVADOC_TO_MDOC
+#if !GEN_JAVA_STUBS&&!JAVADOC_TO_MDOC
 // Keep in sync with ToJniNameFromAttributes(TypeDefinition)
 publicstaticstringToJniNameFromAttributes(Typetype)
 {
@@ -384,7 +384,7 @@ static string ToJniNameWhichShouldReplaceExistingToJniName (Type type, ExportPar
 }
 #endif
 
-#if HAVE_CECIL&&!GENERATOR
+#if HAVE_CECIL
 
 internalstaticExportParameterKindGetExportKind(Mono.Cecil.ICustomAttributeProviderp)
 {

tools/generator/ClassGen.cs

@@ -15,7 +15,7 @@
 usingSystem.Xml.Linq;
 
 namespaceMonoDroid.Generation{
-#if USE_CECIL
+#if HAVE_CECIL
 staticclassManagedExtensions
 {
 publicstaticstringFullNameCorrected(thisTypeReferencet)
@@ -69,7 +69,7 @@ public override bool IsFinal {
 get{returnt.IsSealed;}
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlClassGen:ClassGen{
 boolis_abstract;

tools/generator/CodeGenerator.cs

@@ -14,6 +14,7 @@
 usingXamarin.Android.Tools.ApiXmlAdjuster;
 
 usingJava.Interop.Tools.Cecil;
+usingJava.Interop.Tools.TypeNameMappings;
 
 namespaceXamarin.Android.Binder{
 
@@ -262,8 +263,10 @@ static void Run (CodeGeneratorOptions options, DirectoryAssemblyResolver resolve
 // For now generator fails to load generic types that have conflicting type e.g.
 // AdapterView`1 and AdapterView cannot co-exist.
 // It is mostly because generator primarily targets jar (no real generics land).
-if(td.HasGenericParameters&&
-md.GetType(td.FullName.Substring(0,td.FullName.IndexOf('`')))!=null)
+varnonGenericOverload=td.HasGenericParameters
+?md.GetType(td.FullName.Substring(0,td.FullName.IndexOf('`')))
+:null;
+if(BindSameType(td,nonGenericOverload))
 continue;
 ProcessReferencedType(td,opt);
 }
@@ -366,6 +369,15 @@ static void AddTypeToTable (GenBase gb)
 AddTypeToTable(nt);
 }
 
+staticboolBindSameType(TypeDefinitiona,TypeDefinitionb)
+{
+if(a==null||b==null)
+returnfalse;
+if(!a.ImplementsInterface("Android.Runtime.IJavaObject")||!b.ImplementsInterface("Android.Runtime.IJavaObject"))
+returnfalse;
+returnJniType.ToJniName(a)==JniType.ToJniName(b);
+}
+
 staticIEnumerable<GenBase>FlattenNestedTypes(IEnumerable<GenBase>gens)
 {
 foreach(vargingens){
@@ -404,7 +416,7 @@ static void Validate (List<GenBase> gens, CodeGenerationOptions opt)
 }while(removed.Count>0);
 }
 
-#if USE_CECIL
+#if HAVE_CECIL
 staticvoidProcessReferencedType(TypeDefinitiontd,CodeGenerationOptionsopt)
 {
 if(!td.IsPublic&&!td.IsNested)
@@ -434,7 +446,7 @@ static void ProcessReferencedType (TypeDefinition td, CodeGenerationOptions opt)
 foreach(varntintd.NestedTypes)
 ProcessReferencedType(nt,opt);
 }
-#endif
+#endif// HAVE_CECIL
 
 staticvoidGenerateAnnotationAttributes(List<GenBase>gens,IEnumerable<string>zips)
 {

tools/generator/Ctor.cs

@@ -8,7 +8,7 @@
 usingXamarin.Android.Tools;
 
 namespaceMonoDroid.Generation{
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedCtor:Ctor{
 MethodDefinitionm;
 stringname;
@@ -53,7 +53,7 @@ public override string CustomAttributes {
 get{returnnull;}
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlCtor:Ctor{
 stringname;

tools/generator/Field.cs

@@ -11,7 +11,7 @@
 usingSystem.Xml.Linq;
 
 namespaceMonoDroid.Generation{
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedField:Field{
 FieldDefinitionf;
 stringjava_name;
@@ -83,7 +83,7 @@ protected override Parameter SetterParameter {
 }
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlField:Field{
 

tools/generator/GenBaseSupport.cs

@@ -50,7 +50,7 @@ public static bool IsPrefixableName (string name)
 }
 }
 
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedGenBaseSupport:GenBaseSupport
 {
 TypeDefinitiont;
@@ -152,7 +152,7 @@ public override string Visibility {
 get{returnt.IsPublic||t.IsNestedPublic?"public":"protected internal";}
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlGenBaseSupport:GenBaseSupport
 {

tools/generator/InterfaceGen.cs

@@ -11,7 +11,7 @@
 usingXamarin.Android.Tools;
 
 namespaceMonoDroid.Generation{
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedInterfaceGen:InterfaceGen{
 publicManagedInterfaceGen(TypeDefinitiont)
 :base(newManagedGenBaseSupport(t))
@@ -34,7 +34,7 @@ public override bool MayHaveManagedGenericArguments {
 get{return!this.IsAcw;}
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlInterfaceGen:InterfaceGen{
 

tools/generator/Method.cs

@@ -12,7 +12,7 @@
 usingSystem.Xml.Linq;
 
 namespaceMonoDroid.Generation{
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedMethod:Method{
 MethodDefinitionm;
 stringjava_name;
@@ -121,7 +121,7 @@ public override string CustomAttributes {
 get{returnnull;}
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlMethod:Method{
 

tools/generator/MethodBase.cs

@@ -20,7 +20,7 @@ public interface IMethodBaseSupport {
 stringVisibility{get;}
 }
 
-#if USE_CECIL
+#if HAVE_CECIL
 publicclassManagedMethodBaseSupport:IMethodBaseSupport{
 MethodDefinitionm;
 publicManagedMethodBaseSupport(MethodDefinitionm)
@@ -79,7 +79,7 @@ public IEnumerable<Parameter> GetParameters (CustomAttribute regatt)
 }
 }
 }
-#endif
+#endif// HAVE_CECIL
 
 publicclassXmlMethodBaseSupport:IMethodBaseSupport{
 

tools/generator/Parameter.cs

@@ -284,7 +284,7 @@ public static Parameter FromClassElement (XElement elem)
 returnnewParameter(name,java_package+"."+java_type,null,false);
 }
 
-#if USE_CECIL
+#if HAVE_CECIL
 publicstaticParameterFromManagedParameter(ParameterDefinitionp,stringjnitype,stringrawtype)
 {
 // FIXME: safe to use CLR type name? assuming yes as we often use it in metadatamap.
@@ -297,6 +297,6 @@ public static Parameter FromManagedType (TypeDefinition t, string javaType)
 {
 returnnewParameter("__self",javaType??t.FullName,t.FullName,false);
 }
-#endif
+#endif// HAVE_CECIL
 }
 }