Skip to content

Commit 94c2bc5

Browse files
jpobstjpobst
committed
[class-parse, generator] Allow users to expose Kotlin internal types/methods with metadata.
1 parent 52082e2 commit 94c2bc5

File tree

8 files changed

+116
-24
lines changed

8 files changed

+116
-24
lines changed

‎src/Xamarin.Android.Tools.Bytecode/ClassFile.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,9 @@ public enum ClassAccessFlags {
209209
Synthetic = 0x1000,
210210
Annotation = 0x2000,
211211
Enum = 0x4000,
212+
213+
// This is not a real Java ClassAccessFlag, it is used to denote Kotlin "internal" access.
214+
Internal = 0x10000000,
212215
}
213216
}
214217

‎src/Xamarin.Android.Tools.Bytecode/Kotlin/KotlinFixups.cs‎

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -70,36 +70,57 @@ static void FixupClassVisibility (ClassFile klass, KotlinClass metadata)
7070
// Interfaces should be set to "package-private"
7171
if (klass.AccessFlags.HasFlag (ClassAccessFlags.Interface)) {
7272
Log.Debug ($"Kotlin: Setting internal interface {klass.ThisClass.Name.Value} to package-private");
73-
klass.AccessFlags = SetPackagePrivate (klass.AccessFlags);
73+
klass.AccessFlags = SetVisibility (klass.AccessFlags, null);
7474

7575
foreach (var ic in klass.InnerClasses) {
7676
Log.Debug ($"Kotlin: Setting nested type {ic.InnerClass.Name.Value} in an internal interface to package-private");
77-
ic.InnerClassAccessFlags = SetPackagePrivate (ic.InnerClassAccessFlags);
77+
ic.InnerClassAccessFlags = SetVisibility (ic.InnerClassAccessFlags, null);
7878
}
7979

8080
return;
8181
}
8282

8383
Log.Debug ($"Kotlin: Hiding internal class {klass.ThisClass.Name.Value}");
84-
klass.AccessFlags = ClassAccessFlags.Private;
84+
klass.AccessFlags = SetVisibility (klass.AccessFlags, ClassAccessFlags.Internal);
8585

8686
foreach (var ic in klass.InnerClasses) {
8787
Log.Debug ($"Kotlin: Hiding nested internal type {ic.InnerClass.Name.Value}");
88-
ic.InnerClassAccessFlags = ClassAccessFlags.Private;
88+
ic.InnerClassAccessFlags = SetVisibility (ic.InnerClassAccessFlags, ClassAccessFlags.Internal);
8989
}
9090

9191
return;
9292
}
9393
}
9494

95-
static ClassAccessFlags SetPackagePrivate (ClassAccessFlags flags)
95+
// Passing null for 'newVisibility' parameter means 'package-private'
96+
static ClassAccessFlags SetVisibility (ClassAccessFlags existing, ClassAccessFlags? newVisibility)
9697
{
97-
// Package-private is stored as "no visibility flags"
98-
flags = (flags ^ ClassAccessFlags.Public) & flags;
99-
flags = (flags ^ ClassAccessFlags.Protected) & flags;
100-
flags = (flags ^ ClassAccessFlags.Private) & flags;
98+
// First we need to remove any existing visibility flags,
99+
// without modifying other flags like Abstract
100+
existing = (existing ^ ClassAccessFlags.Public) & existing;
101+
existing = (existing ^ ClassAccessFlags.Protected) & existing;
102+
existing = (existing ^ ClassAccessFlags.Private) & existing;
103+
existing = (existing ^ ClassAccessFlags.Internal) & existing;
104+
105+
// Package-private is stored as "no visibility flags", so only add flag if specified
106+
if (newVisibility.HasValue)
107+
existing |= newVisibility.Value;
108+
109+
return existing;
110+
}
111+
112+
static MethodAccessFlags SetVisibility (MethodAccessFlags existing, MethodAccessFlags newVisibility)
113+
{
114+
// First we need to remove any existing visibility flags,
115+
// without modifying other flags like Abstract
116+
existing = (existing ^ MethodAccessFlags.Public) & existing;
117+
existing = (existing ^ MethodAccessFlags.Protected) & existing;
118+
existing = (existing ^ MethodAccessFlags.Private) & existing;
119+
existing = (existing ^ MethodAccessFlags.Internal) & existing;
101120

102-
return flags;
121+
existing |= newVisibility;
122+
123+
return existing;
103124
}
104125

105126
static void FixupJavaMethods (Methods methods)
@@ -132,7 +153,7 @@ static void FixupConstructor (MethodInfo method, KotlinConstructor metadata)
132153
// Hide constructor if it isn't Public/Protected
133154
if (method.IsPubliclyVisible && !metadata.Flags.IsPubliclyVisible ()) {
134155
Log.Debug ($"Kotlin: Hiding internal constructor {method.DeclaringType?.ThisClass.Name.Value} - {metadata.GetSignature ()}");
135-
method.AccessFlags = MethodAccessFlags.Private;
156+
method.AccessFlags = SetVisibility (method.AccessFlags, MethodAccessFlags.Internal);
136157
}
137158
}
138159

@@ -144,7 +165,7 @@ static void FixupFunction (MethodInfo method, KotlinFunction metadata, KotlinCla
144165
// Hide function if it isn't Public/Protected
145166
if (!metadata.Flags.IsPubliclyVisible ()) {
146167
Log.Debug ($"Kotlin: Hiding internal method {method.DeclaringType?.ThisClass.Name.Value} - {metadata.GetSignature ()}");
147-
method.AccessFlags = MethodAccessFlags.Private;
168+
method.AccessFlags = SetVisibility (method.AccessFlags, MethodAccessFlags.Internal);
148169
return;
149170
}
150171

@@ -190,12 +211,12 @@ static void FixupProperty (MethodInfo getter, MethodInfo setter, KotlinProperty
190211

191212
if (getter?.IsPubliclyVisible == true) {
192213
Log.Debug ($"Kotlin: Hiding internal getter method {getter.DeclaringType?.ThisClass.Name.Value} - {getter.Name}");
193-
getter.AccessFlags = MethodAccessFlags.Private;
214+
getter.AccessFlags = SetVisibility (getter.AccessFlags, MethodAccessFlags.Internal);
194215
}
195216

196217
if (setter?.IsPubliclyVisible == true) {
197218
Log.Debug ($"Kotlin: Hiding internal setter method {setter.DeclaringType?.ThisClass.Name.Value} - {setter.Name}");
198-
setter.AccessFlags = MethodAccessFlags.Private;
219+
setter.AccessFlags = SetVisibility (setter.AccessFlags, MethodAccessFlags.Internal);
199220
}
200221

201222
return;

‎src/Xamarin.Android.Tools.Bytecode/Methods.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,9 @@ public enum MethodAccessFlags {
352352
Abstract = 0x0400,
353353
Strict = 0x0800,
354354
Synthetic = 0x1000,
355+
356+
// This is not a real Java MethodAccessFlags, it is used to denote Kotlin "internal" access.
357+
Internal = 0x10000000,
355358
}
356359

357360
[Flags]

‎src/Xamarin.Android.Tools.Bytecode/XmlClassDeclarationBuilder.cs‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System;
1+
using System;
22
using System.Collections.Generic;
33
using System.Diagnostics;
44
using System.Globalization;
@@ -106,6 +106,8 @@ XAttribute GetExtendsGenericAware ()
106106

107107
static string GetVisibility (ClassAccessFlags accessFlags)
108108
{
109+
if (accessFlags.HasFlag (ClassAccessFlags.Internal))
110+
return "kotlin-internal";
109111
if ((accessFlags & ClassAccessFlags.Public) != 0)
110112
return "public";
111113
if ((accessFlags & ClassAccessFlags.Protected) != 0)
@@ -319,7 +321,7 @@ IEnumerable<XElement> GetImplementedInterfaces ()
319321
IEnumerable<XElement> GetConstructors ()
320322
{
321323
return classFile.Methods.Where (m => m.Name == "<init>"
322-
&& (GetMethodVisibility(m.AccessFlags) == "public" || GetMethodVisibility(m.AccessFlags) == "protected"))
324+
&& (GetMethodVisibility(m.AccessFlags) == "public" || GetMethodVisibility(m.AccessFlags) == "protected" || GetMethodVisibility (m.AccessFlags) == "kotlin-internal"))
323325
.OrderBy (m => m.Name + m.Descriptor, StringComparer.OrdinalIgnoreCase)
324326
.Select (c => GetMethod ("constructor", GetThisClassName (), c, null));
325327
}
@@ -374,6 +376,8 @@ static XAttribute GetSynchronized (MethodInfo method)
374376

375377
static string GetVisibility (MethodAccessFlags accessFlags)
376378
{
379+
if (accessFlags.HasFlag (MethodAccessFlags.Internal))
380+
return "kotlin-internal";
377381
if ((accessFlags & MethodAccessFlags.Public) != 0)
378382
return "public";
379383
if ((accessFlags & MethodAccessFlags.Protected) != 0)
@@ -605,6 +609,8 @@ static string GetVisibility (FieldAccessFlags accessFlags)
605609

606610
static string GetMethodVisibility (MethodAccessFlags accessFlags)
607611
{
612+
if (accessFlags.HasFlag (MethodAccessFlags.Internal))
613+
return "kotlin-internal";
608614
if ((accessFlags & MethodAccessFlags.Public) != 0)
609615
return "public";
610616
if ((accessFlags & MethodAccessFlags.Protected) != 0)
@@ -616,6 +622,8 @@ static string GetMethodVisibility (MethodAccessFlags accessFlags)
616622

617623
static string GetClassVisibility (ClassAccessFlags accessFlags)
618624
{
625+
if (accessFlags.HasFlag (ClassAccessFlags.Internal))
626+
return "kotlin-internal";
619627
if ((accessFlags & ClassAccessFlags.Public) != 0)
620628
return "public";
621629
if ((accessFlags & ClassAccessFlags.Protected) != 0)
@@ -628,7 +636,7 @@ static string GetClassVisibility (ClassAccessFlags accessFlags)
628636
IEnumerable<XElement> GetMethods ()
629637
{
630638
return classFile.Methods.Where (m => !m.Name.StartsWith ("<", StringComparison.OrdinalIgnoreCase)
631-
&& (GetMethodVisibility(m.AccessFlags) == "public" || GetMethodVisibility(m.AccessFlags) == "protected"))
639+
&& (GetMethodVisibility(m.AccessFlags) == "public" || GetMethodVisibility(m.AccessFlags) == "protected" || GetMethodVisibility (m.AccessFlags) == "kotlin-internal"))
632640
.OrderBy (m => m.Name + m.Descriptor, StringComparer.OrdinalIgnoreCase)
633641
.Select (m => GetMethod ("method", m.Name, m,
634642
returns: m.ReturnType.TypeSignature));

‎tests/Xamarin.Android.Tools.Bytecode-Tests/KotlinFixupsTests.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ public void HideInternalClass ()
2424

2525
Assert.False (klass.AccessFlags.HasFlag (ClassAccessFlags.Public));
2626
Assert.False (inner_class.InnerClassAccessFlags.HasFlag (ClassAccessFlags.Public));
27+
28+
var output = new XmlClassDeclarationBuilder (klass).ToXElement ().ToString ();
29+
Assert.True (output.Contains ("visibility=\"kotlin-internal\""));
2730
}
2831

2932
[Test]
@@ -58,6 +61,9 @@ public void HideInternalConstructor ()
5861
KotlinFixups.Fixup (new [] { klass });
5962

6063
Assert.False (ctor.AccessFlags.HasFlag (MethodAccessFlags.Public));
64+
65+
var output = new XmlClassDeclarationBuilder (klass).ToXElement ().ToString ();
66+
Assert.True (output.Contains ("visibility=\"kotlin-internal\""));
6167
}
6268

6369
[Test]
@@ -124,6 +130,9 @@ public void HideInternalMethod ()
124130
KotlinFixups.Fixup (new [] { klass });
125131

126132
Assert.False (method.AccessFlags.HasFlag (MethodAccessFlags.Public));
133+
134+
var output = new XmlClassDeclarationBuilder (klass).ToXElement ().ToString ();
135+
Assert.True (output.Contains ("visibility=\"kotlin-internal\""));
127136
}
128137

129138
[Test]
@@ -154,6 +163,9 @@ public void HideInternalProperty ()
154163

155164
Assert.False (getter.AccessFlags.HasFlag (MethodAccessFlags.Public));
156165
Assert.False (setter.AccessFlags.HasFlag (MethodAccessFlags.Public));
166+
167+
var output = new XmlClassDeclarationBuilder (klass).ToXElement ().ToString ();
168+
Assert.True (output.Contains ("visibility=\"kotlin-internal\""));
157169
}
158170

159171
[Test]

‎tests/generator-Tests/Unit-Tests/XmlApiImporterTests.cs‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System;
2+
using System.Collections.Generic;
23
using System.Linq;
34
using System.Xml.Linq;
45
using MonoDroid.Generation;
@@ -244,5 +245,44 @@ public void PreserveSourceLineInfo ()
244245
Assert.AreEqual (2, method.LinePosition);
245246
Assert.AreEqual ("obj/Debug/api.xml", method.SourceFile);
246247
}
248+
249+
[Test]
250+
public void IgnoreKotlinInternalClasses ()
251+
{
252+
var xml = XDocument.Parse ("<api><package name='com.example.test' jni-name='com/example/test'><class name='test' visibility='kotlin-internal'></class></package></api>");
253+
var gens = new Parser (opt).Parse (xml, new List<string> (), "0", 0);
254+
255+
Assert.AreEqual (0, gens.Count);
256+
}
257+
258+
[Test]
259+
public void IgnoreKotlinInternalInterfaces ()
260+
{
261+
var xml = XDocument.Parse ("<api><package name='com.example.test' jni-name='com/example/test'><interface name='test' visibility='kotlin-internal'></interface></package></api>");
262+
var gens = new Parser (opt).Parse (xml, new List<string> (), "0", 0);
263+
264+
Assert.AreEqual (0, gens.Count);
265+
}
266+
267+
[Test]
268+
public void IgnoreKotlinInternalMembers ()
269+
{
270+
var xml = XDocument.Parse (@"
271+
<api>
272+
<package name='com.example.test' jni-name='com/example/test'>
273+
<class name='Test' visibility='public'>
274+
<constructor name='Test' visibility='kotlin-internal' />
275+
<method name='DoStuff' visibility='kotlin-internal' />
276+
<field name='MyField' visibility='kotlin-internal' />
277+
</class>
278+
</package>
279+
</api>");
280+
281+
var gens = new Parser (opt).Parse (xml, new List<string> (), "0", 0);
282+
var klass = gens.Single ();
283+
284+
Assert.AreEqual (0, klass.Fields.Count);
285+
Assert.AreEqual (0, klass.Methods.Count);
286+
}
247287
}
248288
}

‎tools/generator/Java.Interop.Tools.Generator.Importers/XmlApiImporter.cs‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,16 @@ public static ClassGen CreateClass (XElement pkg, XElement elem, CodeGenerationO
3737
klass.AddImplementedInterface (iname);
3838
break;
3939
case "method":
40-
klass.AddMethod (CreateMethod (klass, child, options));
40+
if (child.XGetAttribute ("visibility") != "kotlin-internal")
41+
klass.AddMethod (CreateMethod (klass, child, options));
4142
break;
4243
case "constructor":
43-
klass.Ctors.Add (CreateCtor (klass, child, options));
44+
if (child.XGetAttribute ("visibility") != "kotlin-internal")
45+
klass.Ctors.Add (CreateCtor (klass, child, options));
4446
break;
4547
case "field":
46-
klass.AddField (CreateField (klass, child, options));
48+
if (child.XGetAttribute ("visibility") != "kotlin-internal")
49+
klass.AddField (CreateField (klass, child, options));
4750
break;
4851
case "typeParameters":
4952
break; // handled at GenBaseSupport
@@ -230,10 +233,12 @@ public static InterfaceGen CreateInterface (XElement pkg, XElement elem, CodeGen
230233
iface.AddImplementedInterface (iname);
231234
break;
232235
case "method":
233-
iface.AddMethod (CreateMethod (iface, child, options));
236+
if (child.XGetAttribute ("visibility") != "kotlin-internal")
237+
iface.AddMethod (CreateMethod (iface, child, options));
234238
break;
235239
case "field":
236-
iface.AddField (CreateField (iface, child, options));
240+
if (child.XGetAttribute ("visibility") != "kotlin-internal")
241+
iface.AddField (CreateField (iface, child, options));
237242
break;
238243
case "typeParameters":
239244
break; // handled at GenBaseSupport

‎tools/generator/Java.Interop.Tools.Generator.Transformation/Parser.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,12 @@ List<GenBase> ParsePackage (XElement ns, Predicate<XElement> p)
103103
GenBase gen = null;
104104
switch (elem.Name.LocalName) {
105105
case "class":
106-
if (elem.XGetAttribute ("obfuscated") == "true")
106+
if (elem.XGetAttribute ("obfuscated") == "true" || elem.XGetAttribute ("visibility") == "kotlin-internal")
107107
continue;
108108
gen = XmlApiImporter.CreateClass (ns, elem, opt);
109109
break;
110110
case "interface":
111-
if (elem.XGetAttribute ("obfuscated") == "true")
111+
if (elem.XGetAttribute ("obfuscated") == "true" || elem.XGetAttribute ("visibility") == "kotlin-internal")
112112
continue;
113113
gen = XmlApiImporter.CreateInterface (ns, elem, opt);
114114
break;

0 commit comments

Comments
 (0)