blob: 06780cbb1ebe5579b6f45c7a5f9a40ff863c4dfe [file]
// Copyright (c) 2026, the R8 project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
package com.android.tools.r8;
import com.android.tools.r8.apimodel.AmendApiFromResources;
import com.android.tools.r8.apimodel.AmendmentListener;
import com.android.tools.r8.apimodel.AndroidApiHashingDatabaseBuilderGenerator;
import com.android.tools.r8.apimodel.AndroidApiHashingDatabaseBuilderGenerator.GenerationException;
import com.android.tools.r8.apimodel.AndroidApiVersionsXmlParser;
import com.android.tools.r8.apimodel.AndroidApiVersionsXmlParser.ParsingException;
import com.android.tools.r8.apimodel.FieldTypelessReference;
import com.android.tools.r8.apimodel.ParsedApiClass;
import com.android.tools.r8.apimodel.ParsedApiClassFlattening;
import com.android.tools.r8.apimodel.ParsedApiClassMapping;
import com.android.tools.r8.apimodel.ParsedApiClassMapping.GreatestEndingRangeMapper;
import com.android.tools.r8.apimodel.ParsedApiClassMapping.Mapper;
import com.android.tools.r8.apimodel.ParsedApiClassMerging;
import com.android.tools.r8.apimodel.ParsedApiClassSorting;
import com.android.tools.r8.apimodel.ParsedApiClassTrimming;
import com.android.tools.r8.apimodel.ParsedApiClassTrimming.JarTrimmer;
import com.android.tools.r8.apimodel.ParsedApiClassTrimming.RemovedTrimmer;
import com.android.tools.r8.apimodel.ParsedApiClassTrimming.Trimmer;
import com.android.tools.r8.apimodel.ParsedApiClassVerifier;
import com.android.tools.r8.apimodel.ParsedApiClassVerifier.SemiInfiniteRangeSetOperations;
import com.android.tools.r8.apimodel.jar.ApiJarInfo;
import com.android.tools.r8.apimodel.jar.ApiJarMerging;
import com.android.tools.r8.apimodel.jar.ApiJarReader;
import com.android.tools.r8.keepanno.annotations.KeepForApi;
import com.android.tools.r8.origin.CommandLineOrigin;
import com.android.tools.r8.references.ClassReference;
import com.android.tools.r8.references.MethodReference;
import com.android.tools.r8.utils.AndroidApiLevel;
import com.android.tools.r8.utils.ExceptionUtils;
import com.android.tools.r8.utils.ResolvedAndroidApiLevel;
import com.android.tools.r8.utils.UncheckedApiLevel;
import com.android.tools.r8.utils.internal.SemiInfiniteRange;
import com.android.tools.r8.utils.internal.SemiInfiniteRangeSet;
import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.function.Function;
@KeepForApi
public class ApiDatabaseGenerator {
public static void run(ApiDatabaseGeneratorCommand command) throws ApiDatabaseGeneratorException {
run(command, AmendmentListener.empty(), trimmer -> trimmer);
}
static void run(
ApiDatabaseGeneratorCommand command,
AmendmentListener amendmentListener,
Function<
JarTrimmer<SemiInfiniteRange<UncheckedApiLevel>>,
Trimmer<SemiInfiniteRange<UncheckedApiLevel>, ApiDatabaseGeneratorException>>
jarTrimmerWrapper)
throws ApiDatabaseGeneratorException {
if (command.isPrintHelp()) {
System.out.println(ApiDatabaseGeneratorCommandParser.getUsageMessage());
return;
}
if (command.isPrintVersion()) {
System.out.println("ApiDatabaseGenerator " + Version.getVersionString());
return;
}
ExceptionUtils.withDiagnosticsHandler(
command.getReporter(),
() -> runInternal(command, amendmentListener, jarTrimmerWrapper),
(message, cause, cancelled) -> new ApiDatabaseGeneratorException(message, cause));
}
private static void runInternal(
ApiDatabaseGeneratorCommand command,
AmendmentListener amendmentListener,
Function<
JarTrimmer<SemiInfiniteRange<UncheckedApiLevel>>,
Trimmer<SemiInfiniteRange<UncheckedApiLevel>, ApiDatabaseGeneratorException>>
jarTrimmerWrapper)
throws ApiDatabaseGeneratorException {
try {
var apiClasses = generateClasses(command, amendmentListener, jarTrimmerWrapper);
var entries = AndroidApiHashingDatabaseBuilderGenerator.generateEntries(apiClasses);
AndroidApiHashingDatabaseBuilderGenerator.writeEntries(entries, command.getOutputPath());
} catch (GenerationException e) {
throw new ApiDatabaseGeneratorException("Failed to generate API database", e);
}
}
static <E extends Throwable>
Collection<ParsedApiClass<SemiInfiniteRange<AndroidApiLevel>>> generateClasses(
ApiDatabaseGeneratorCommand command,
AmendmentListener amendmentListener,
Function<
JarTrimmer<SemiInfiniteRange<UncheckedApiLevel>>,
Trimmer<SemiInfiniteRange<UncheckedApiLevel>, E>>
jarTrimmerWrapper)
throws ApiDatabaseGeneratorException, E {
try {
Collection<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> classes =
extractClasses(command);
classes = ParsedApiClassMerging.merge(classes, command.getDiagnosticsHandler());
List<ApiJarInfo> jarInfos = extractJars(command);
ApiJarInfo jarInfo = ApiJarMerging.mergeJarInfos(jarInfos);
if (command.shouldAmend()) {
amendApiData(classes, jarInfo, amendmentListener);
}
Collection<ParsedApiClass<SemiInfiniteRangeSet<UncheckedApiLevel>>> flattenedClasses =
flattenHierarchy(classes);
classes = ParsedApiClassMapping.map(flattenedClasses, new GreatestEndingRangeMapper<>());
classes =
ParsedApiClassTrimming.trim(classes, new RemovedTrimmer(command.allowFutureVersions()));
Trimmer<SemiInfiniteRange<UncheckedApiLevel>, E> jarTrimmer =
jarTrimmerWrapper.apply(new JarTrimmer<>(jarInfo));
classes = ParsedApiClassTrimming.trim(classes, jarTrimmer);
classes = ParsedApiClassSorting.sorted(classes);
ParsedApiClassVerifier.verify(classes, new SemiInfiniteRangeSetOperations<>());
return ParsedApiClassMapping.map(classes, new AndroidApiLevelMapper());
} catch (ParsingException | IOException e) {
throw new ApiDatabaseGeneratorException("Failed to generate API classes", e);
}
}
private static class AndroidApiLevelMapper
implements Mapper<
SemiInfiniteRange<UncheckedApiLevel>,
SemiInfiniteRange<AndroidApiLevel>,
ApiDatabaseGeneratorException> {
private AndroidApiLevel mapLevel(UncheckedApiLevel apiLevel)
throws ApiDatabaseGeneratorException {
ResolvedAndroidApiLevel resolved = AndroidApiLevel.resolveAndroidApiLevel(apiLevel);
if (resolved.isKnown()) {
return resolved.asKnown().getApiLevel();
}
throw new ApiDatabaseGeneratorException("Invalid Android API level: " + apiLevel);
}
private SemiInfiniteRange<AndroidApiLevel> mapRange(SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return new SemiInfiniteRange<>(
mapLevel(range.start), range.hasEnd() ? mapLevel(range.end) : null);
}
@Override
public SemiInfiniteRange<AndroidApiLevel> mapClass(
ClassReference clazz, SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return mapRange(range);
}
@Override
public SemiInfiniteRange<AndroidApiLevel> mapExtends(
ClassReference clazz, ClassReference supertype, SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return mapRange(range);
}
@Override
public SemiInfiniteRange<AndroidApiLevel> mapImplements(
ClassReference clazz, ClassReference supertype, SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return mapRange(range);
}
@Override
public SemiInfiniteRange<AndroidApiLevel> mapMethod(
ClassReference clazz, MethodReference method, SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return mapRange(range);
}
@Override
public SemiInfiniteRange<AndroidApiLevel> mapField(
ClassReference clazz,
FieldTypelessReference field,
SemiInfiniteRange<UncheckedApiLevel> range)
throws ApiDatabaseGeneratorException {
return mapRange(range);
}
@Override
public void done() {
// Do nothing.
}
}
private static Collection<ParsedApiClass<SemiInfiniteRangeSet<UncheckedApiLevel>>>
flattenHierarchy(Collection<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> classes)
throws ApiDatabaseGeneratorException {
try {
return ParsedApiClassFlattening.flatten(classes);
} catch (ApiDatabaseGeneratorException e) {
throw new ApiDatabaseGeneratorException("Could not flatten class hierarchy", e);
}
}
private static void amendApiData(
Collection<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> classes,
ApiJarInfo jarInfo,
AmendmentListener amendmentListener)
throws ApiDatabaseGeneratorException, IOException {
try {
AmendApiFromResources.applyAmendments(classes, jarInfo, amendmentListener);
} catch (ApiDatabaseGeneratorException e) {
throw new ApiDatabaseGeneratorException("Database amendment failed", e);
} catch (IOException e) {
throw new IOException("Database amendment failed", e);
}
}
private static List<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> extractClasses(
ApiDatabaseGeneratorCommand command) throws ParsingException {
List<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> allParsed = new ArrayList<>();
for (Path xmlPath : command.getXmlPaths()) {
List<ParsedApiClass<SemiInfiniteRange<UncheckedApiLevel>>> parsed =
AndroidApiVersionsXmlParser.parse(xmlPath);
allParsed.addAll(parsed);
}
return allParsed;
}
private static List<ApiJarInfo> extractJars(ApiDatabaseGeneratorCommand command)
throws ApiDatabaseGeneratorException, IOException {
List<ApiJarInfo> allRead = new ArrayList<>();
for (Path jarPath : command.getJarPaths()) {
allRead.add(ApiJarReader.read(jarPath));
}
return allRead;
}
public static void main(String[] args) {
try {
run(ApiDatabaseGeneratorCommand.parse(args, CommandLineOrigin.INSTANCE).build());
} catch (ApiDatabaseGeneratorException e) {
System.err.println("API Database Generation failed: " + e.getMessage());
if (e.getCause() != null) {
System.err.println("Cause: " + e.getCause().getMessage());
}
throw new RuntimeException(e);
} catch (RuntimeException e) {
System.err.println("API Database Generation failed with an internal error.");
throw e;
}
}
}