-
Notifications
You must be signed in to change notification settings - Fork 569
Expand file tree
/
Copy pathTrimmableTypeMapGenerator.cs
More file actions
288 lines (248 loc) · 10.7 KB
/
TrimmableTypeMapGenerator.cs
File metadata and controls
288 lines (248 loc) · 10.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection.PortableExecutable;
using System.Xml.Linq;
namespace Microsoft.Android.Sdk.TrimmableTypeMap;
public class TrimmableTypeMapGenerator
{
readonly ITrimmableTypeMapLogger logger;
public TrimmableTypeMapGenerator (ITrimmableTypeMapLogger logger)
{
this.logger = logger ?? throw new ArgumentNullException (nameof (logger));
}
/// <summary>
/// Runs the full generation pipeline: scan assemblies, generate typemap
/// assemblies, generate JCW Java sources, and optionally generate a merged manifest.
/// No file IO is performed — all results are returned in memory.
/// </summary>
public TrimmableTypeMapResult Execute (
IReadOnlyList<(string Name, PEReader Reader)> assemblies,
Version systemRuntimeVersion,
HashSet<string> frameworkAssemblyNames,
ManifestConfig? manifestConfig = null,
XDocument? manifestTemplate = null)
{
_ = assemblies ?? throw new ArgumentNullException (nameof (assemblies));
_ = systemRuntimeVersion ?? throw new ArgumentNullException (nameof (systemRuntimeVersion));
_ = frameworkAssemblyNames ?? throw new ArgumentNullException (nameof (frameworkAssemblyNames));
var (allPeers, assemblyManifestInfo) = ScanAssemblies (assemblies);
if (allPeers.Count == 0) {
logger.LogNoJavaPeerTypesFound ();
return new TrimmableTypeMapResult ([], [], allPeers);
}
RootManifestReferencedTypes (allPeers, PrepareManifestForRooting (manifestTemplate, manifestConfig));
var generatedAssemblies = GenerateTypeMapAssemblies (allPeers, systemRuntimeVersion);
var jcwPeers = allPeers.Where (p =>
!frameworkAssemblyNames.Contains (p.AssemblyName)
|| p.JavaName.StartsWith ("mono/", StringComparison.Ordinal)).ToList ();
logger.LogGeneratingJcwFilesInfo (jcwPeers.Count, allPeers.Count);
var generatedJavaSources = GenerateJcwJavaSources (jcwPeers);
// Collect Application/Instrumentation types that need deferred registerNatives
var appRegTypes = allPeers
.Where (p => p.CannotRegisterInStaticConstructor && !p.IsAbstract)
.Select (p => JniSignatureHelper.JniNameToJavaName (p.JavaName))
.ToList ();
if (appRegTypes.Count > 0) {
logger.LogDeferredRegistrationTypesInfo (appRegTypes.Count);
}
var manifest = manifestConfig is not null
? GenerateManifest (allPeers, assemblyManifestInfo, manifestConfig, manifestTemplate)
: null;
return new TrimmableTypeMapResult (generatedAssemblies, generatedJavaSources, allPeers, manifest, appRegTypes);
}
GeneratedManifest GenerateManifest (List<JavaPeerInfo> allPeers, AssemblyManifestInfo assemblyManifestInfo,
ManifestConfig config, XDocument? manifestTemplate)
{
string minSdk = config.SupportedOSPlatformVersion ?? throw new InvalidOperationException ("SupportedOSPlatformVersion must be provided by MSBuild.");
if (Version.TryParse (minSdk, out var sopv)) {
minSdk = sopv.Major.ToString (System.Globalization.CultureInfo.InvariantCulture);
}
string targetSdk = config.AndroidApiLevel ?? throw new InvalidOperationException ("AndroidApiLevel must be provided by MSBuild.");
if (Version.TryParse (targetSdk, out var apiVersion)) {
targetSdk = apiVersion.Major.ToString (System.Globalization.CultureInfo.InvariantCulture);
}
bool forceDebuggable = !config.CheckedBuild.IsNullOrEmpty ();
var generator = new ManifestGenerator {
PackageName = config.PackageName,
ApplicationLabel = config.ApplicationLabel ?? config.PackageName,
VersionCode = config.VersionCode ?? "",
VersionName = config.VersionName ?? "",
MinSdkVersion = minSdk,
TargetSdkVersion = targetSdk,
RuntimeProviderJavaName = config.RuntimeProviderJavaName ?? throw new InvalidOperationException ("RuntimeProviderJavaName must be provided by MSBuild."),
Debug = config.Debug,
NeedsInternet = config.NeedsInternet,
EmbedAssemblies = config.EmbedAssemblies,
ForceDebuggable = forceDebuggable,
ForceExtractNativeLibs = forceDebuggable,
ManifestPlaceholders = config.ManifestPlaceholders,
ApplicationJavaClass = config.ApplicationJavaClass,
};
var (doc, providerNames) = generator.Generate (manifestTemplate, allPeers, assemblyManifestInfo);
return new GeneratedManifest (doc, providerNames.Count > 0 ? providerNames.ToArray () : []);
}
(List<JavaPeerInfo> peers, AssemblyManifestInfo manifestInfo) ScanAssemblies (IReadOnlyList<(string Name, PEReader Reader)> assemblies)
{
using var scanner = new JavaPeerScanner ();
var peers = scanner.Scan (assemblies);
var manifestInfo = scanner.ScanAssemblyManifestInfo ();
logger.LogJavaPeerScanInfo (assemblies.Count, peers.Count);
return (peers, manifestInfo);
}
List<GeneratedAssembly> GenerateTypeMapAssemblies (List<JavaPeerInfo> allPeers, Version systemRuntimeVersion)
{
var peersByAssembly = allPeers.GroupBy (p => p.AssemblyName, StringComparer.Ordinal).OrderBy (g => g.Key, StringComparer.Ordinal);
var generatedAssemblies = new List<GeneratedAssembly> ();
var perAssemblyNames = new List<string> ();
var generator = new TypeMapAssemblyGenerator (systemRuntimeVersion);
foreach (var group in peersByAssembly) {
string assemblyName = $"_{group.Key}.TypeMap";
perAssemblyNames.Add (assemblyName);
var peers = group.ToList ();
var stream = new MemoryStream ();
generator.Generate (peers, stream, assemblyName);
stream.Position = 0;
generatedAssemblies.Add (new GeneratedAssembly (assemblyName, stream));
logger.LogGeneratedTypeMapAssemblyInfo (assemblyName, peers.Count);
}
var rootStream = new MemoryStream ();
var rootGenerator = new RootTypeMapAssemblyGenerator (systemRuntimeVersion);
rootGenerator.Generate (perAssemblyNames, rootStream);
rootStream.Position = 0;
generatedAssemblies.Add (new GeneratedAssembly ("_Microsoft.Android.TypeMaps", rootStream));
logger.LogGeneratedRootTypeMapInfo (perAssemblyNames.Count);
logger.LogGeneratedTypeMapAssembliesInfo (generatedAssemblies.Count);
return generatedAssemblies;
}
List<GeneratedJavaSource> GenerateJcwJavaSources (List<JavaPeerInfo> allPeers)
{
var jcwGenerator = new JcwJavaSourceGenerator ();
var sources = jcwGenerator.GenerateContent (allPeers);
logger.LogGeneratedJcwFilesInfo (sources.Count);
return sources.ToList ();
}
internal void RootManifestReferencedTypes (List<JavaPeerInfo> allPeers, XDocument? doc)
{
if (doc?.Root is not { } root) {
return;
}
XNamespace androidNs = "http://schemas.android.com/apk/res/android";
XName attName = androidNs + "name";
var packageName = (string?) root.Attribute ("package") ?? "";
var componentNames = new HashSet<string> (StringComparer.Ordinal);
var deferredRegistrationNames = new HashSet<string> (StringComparer.Ordinal);
foreach (var element in root.Descendants ()) {
switch (element.Name.LocalName) {
case "application":
case "activity":
case "instrumentation":
case "service":
case "receiver":
case "provider":
var name = (string?) element.Attribute (attName);
if (name is not null) {
var resolvedName = ResolveManifestClassName (name, packageName);
componentNames.Add (resolvedName);
if (element.Name.LocalName is "application" or "instrumentation") {
deferredRegistrationNames.Add (resolvedName);
}
}
break;
}
}
if (componentNames.Count == 0) {
return;
}
// Build lookup by both Java and compat dot-names. Keep '$' for nested types,
// because manifests commonly use '$', but also include the Java source form.
var peersByDotName = new Dictionary<string, List<JavaPeerInfo>> (StringComparer.Ordinal);
foreach (var peer in allPeers) {
AddJniLookupNames (peersByDotName, peer.JavaName, peer);
if (peer.CompatJniName != peer.JavaName) {
AddJniLookupNames (peersByDotName, peer.CompatJniName, peer);
}
}
foreach (var name in componentNames) {
if (peersByDotName.TryGetValue (name, out var peers)) {
foreach (var peer in peers) {
if (deferredRegistrationNames.Contains (name)) {
peer.CannotRegisterInStaticConstructor = true;
}
if (!peer.IsUnconditional) {
peer.IsUnconditional = true;
logger.LogRootingManifestReferencedTypeInfo (name, peer.ManagedTypeName);
}
}
} else {
logger.LogManifestReferencedTypeNotFoundWarning (name);
}
}
}
static void AddPeerByDotName (Dictionary<string, List<JavaPeerInfo>> peersByDotName, string dotName, JavaPeerInfo peer)
{
if (!peersByDotName.TryGetValue (dotName, out var list)) {
list = [];
peersByDotName [dotName] = list;
}
list.Add (peer);
}
static XDocument? PrepareManifestForRooting (XDocument? manifestTemplate, ManifestConfig? manifestConfig)
{
if (manifestTemplate is null && manifestConfig is null) {
return null;
}
var doc = manifestTemplate is not null
? new XDocument (manifestTemplate)
: new XDocument (
new XElement (
"manifest",
new XAttribute (XNamespace.Xmlns + "android", ManifestConstants.AndroidNs.NamespaceName)));
if (doc.Root is not { } root) {
return doc;
}
if (manifestConfig is null) {
return doc;
}
if (((string?) root.Attribute ("package")).IsNullOrEmpty () && !manifestConfig.PackageName.IsNullOrEmpty ()) {
root.SetAttributeValue ("package", manifestConfig.PackageName);
}
ManifestGenerator.ApplyPlaceholders (doc, manifestConfig.ManifestPlaceholders);
if (!manifestConfig.ApplicationJavaClass.IsNullOrEmpty ()) {
var app = root.Element ("application");
if (app is null) {
app = new XElement ("application");
root.Add (app);
}
if (app.Attribute (ManifestConstants.AttName) is null) {
app.SetAttributeValue (ManifestConstants.AttName, manifestConfig.ApplicationJavaClass);
}
}
return doc;
}
static void AddJniLookupNames (Dictionary<string, List<JavaPeerInfo>> peersByDotName, string jniName, JavaPeerInfo peer)
{
var simpleName = JniSignatureHelper.GetJavaSimpleName (jniName);
var packageName = JniSignatureHelper.GetJavaPackageName (jniName);
var manifestName = packageName.IsNullOrEmpty () ? simpleName : packageName + "." + simpleName;
AddPeerByDotName (peersByDotName, manifestName, peer);
var javaSourceName = JniSignatureHelper.JniNameToJavaName (jniName);
if (javaSourceName != manifestName) {
AddPeerByDotName (peersByDotName, javaSourceName, peer);
}
}
/// <summary>
/// Resolves an android:name value to a fully-qualified class name.
/// Names starting with '.' are relative to the package. Names with no '.' at all
/// are also treated as relative (Android tooling convention).
/// </summary>
static string ResolveManifestClassName (string name, string packageName)
{
return name switch {
_ when name.StartsWith (".", StringComparison.Ordinal) => packageName + name,
_ when name.IndexOf ('.') < 0 && !packageName.IsNullOrEmpty () => packageName + "." + name,
_ => name,
};
}
}