tools/dependency_mapper/src/com/android/dependencymapper/Utils.java

/*
 * Copyright (C) 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.dependencymapper;

import com.android.dependencymapper.DependencyProto;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class Utils {
    private static final String FILE_PATH_REGEX = "'([^']*)'|(\\S+)";

    public static String trimAndConvertToPackageBasedPath(String fileBasedPath) {
        // Remove ".class" from the fileBasedPath, then replace "/" with "."
        return fileBasedPath.replaceAll("\\..*", "").replaceAll("/", ".");
    }

    public static String convertClassToFileBasedPath(String packageBasedClass) {
        // Remove ".class" from the fileBasedPath, then replace "/" with "."
        return packageBasedClass.replaceAll("\\.", "/") + ".class";
    }

    public static String buildPackagePrependedClassSource(String qualifiedClassPath,
            String classSource) {
        // Find the location of the start of classname in the qualifiedClassPath
        int classNameSt = qualifiedClassPath.lastIndexOf(".") + 1;
        // Replace the classname in qualifiedClassPath with classSource
        return qualifiedClassPath.substring(0, classNameSt) + classSource;
    }

    public static void writeContentsToJson(DependencyProto.FileDependencyList contents, Path jsonOut) {
        Gson gson = new GsonBuilder().setPrettyPrinting().create();
        Map<String, Map<String, Object>> nestedJsonMap = new HashMap<>();
        for (DependencyProto.FileDependency fileDependency : contents.getFileDependencyList()) {
            String filePath = fileDependency.getFilePath();
            // Keep innerMap in sync with the structure of DependencyProto.FileDependencyList
            Map<String, Object> innerMap = nestedJsonMap.computeIfAbsent(filePath, k -> new HashMap<>());
            innerMap.put("fileDependencies", new HashSet<>(fileDependency.getFileDependenciesList()));
            innerMap.put("generatedClasses", new HashSet<>(fileDependency.getGeneratedClassesList()));
            innerMap.put("crossModuleClassDeps", new HashSet<>(fileDependency.getCrossModuleClassDepsList()));
            if (fileDependency.getIsDependencyToAll()) {
                innerMap.put("isDependencyToAll", true);
            } else {
                innerMap.put("isDependencyToAll", false);
            }
        }
        String json = gson.toJson(nestedJsonMap);
        try (FileWriter file = new FileWriter(jsonOut.toFile())) {
            file.write(json);
        } catch (IOException e) {
            System.err.println("Error writing json output to: " + jsonOut);
            throw new RuntimeException(e);
        }
    }

    public static void writeContentsToProto(DependencyProto.FileDependencyList usages, Path protoOut) {
        try {
            OutputStream outputStream = Files.newOutputStream(protoOut);
            usages.writeTo(outputStream);
        } catch (IOException e) {
            System.err.println("Error writing proto output to: " + protoOut);
            throw new RuntimeException(e);
        }
    }

    public static Set<String> listClassesInJar(Path classesJarPath) {
        Set<String> classes = new HashSet<>();
        try (JarFile jarFile = new JarFile(classesJarPath.toFile())) {
            Enumeration<JarEntry> entries = jarFile.entries();
            while (entries.hasMoreElements()) {
                JarEntry entry = entries.nextElement();
                if (entry.getName().endsWith(".class")) {
                    String name = Utils.trimAndConvertToPackageBasedPath(entry.getName());
                    classes.add(name);
                }
            }
        } catch (IOException e) {
            System.err.println("Error reading the jar file at: " + classesJarPath);
            throw new RuntimeException(e);
        }
        return classes;
    }

    public static Set<String> parseRspFile(Path rspFile) {
        Set<String> files = new HashSet<>();
        if (!rspFile.toFile().exists()) {
            return files;
        }
        try (BufferedReader reader = new BufferedReader(new FileReader(rspFile.toFile()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                Pattern pattern = Pattern.compile(FILE_PATH_REGEX);
                Matcher matcher = pattern.matcher(line);
                while (matcher.find()) {
                    if (matcher.group(1) != null) {
                        // Group 1: Single-quoted string (without the quotes)
                        files.add(matcher.group(1));
                    } else {
                        // Group 2: Non-whitespace sequence
                        files.add(matcher.group(2));
                    }
                }
            }
        } catch (IOException e) {
            System.err.println("Error reading rsp file at: " + rspFile);
            throw new RuntimeException(e);
        }
        return files;
    }
}