net.neoforged.art.api.Renamer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of AutoRenamingTool Show documentation
A tool that renames java bytecode elements.
There is a newer version: 2.0.5
/*
 * Copyright (c) Forge Development LLC and contributors
 * SPDX-License-Identifier: LGPL-2.1-only
 */

package net.neoforged.art.api;

import java.io.Closeable;
import java.io.File;
import java.util.function.Consumer;

import net.neoforged.art.internal.RenamerBuilder;

/**
 * A {@code Renamer} is used to run generic transformers on a JAR file.
 */
public interface Renamer extends Closeable {
    /**
     * Runs the renamer and all registered transformers on the input JAR file,
     * and then outputs it to the output JAR file.
     * This method is guaranteed to be repeatable with multiple inputs and outputs.
     *
     * @param input the input JAR file to process
     * @param output the output JAR file location
     */
    void run(File input, File output);

    /**
     * Creates a default instance of a {@link Builder}.
     * 
     * Logs will be logged to {@link System#out} by default.
     * Debug logs will be swallowed by default.
     * Library files can be both ZIP files and directories.
     * The default number of threads is determined from {@link Runtime#availableProcessors()}.
     */
    static Builder builder() {
        return new RenamerBuilder();
    }

    /**
     * A {@code Renamer.Builder} is used to configure and construct a {@link Renamer}.
     */
    public interface Builder {
        /**
         * Adds a library file to the classpath to use for inheritance.
         *
         * @param value the library file
         * @return this builder
         */
        Builder lib(File value);

        /**
         * Adds a mapping transformer using the provided mapping file.
         *
         * @param value the mapping file
         * @return this builder
         */
        Builder map(File value);

        /**
         * Adds a class provider to use when searching for classes during transformation.
         *
         * @param classProvider the class provider instance
         * @return this builder
         */
        Builder addClassProvider(ClassProvider classProvider);

        /**
         * Adds the default jvm classpath as a class provider to search
         * when a class is not found in any other class provider.
         *
         * @return this builder
         */
        Builder withJvmClasspath();

        /**
         * Adds a generic transformer to run over the input JAR file.
         *
         * @param value the transformer
         * @return this builder
         */
        Builder add(Transformer value);

        /**
         * Adds a generic transformer factory to create a transformer
         * which is then run over the input JAR file.
         *
         * @param factory the transformer factory
         * @return this builder
         */
        Builder add(Transformer.Factory factory);

        /**
         * Sets the number of asynchronous threads to use to process all entries.
         *
         * @param value the number of threads to use
         * @return this builder
         */
        Builder threads(int value);

        /**
         * Sets the logging consumer to use for standard logging.
         *
         * @param out the logging consumer
         * @return this builder
         */
        Builder logger(Consumer out);

        /**
         * Sets the debug logging consumer to use for standard debug output.
         *
         * @param debug the debug logging consumer
         * @return this builder
         */
        Builder debug(Consumer debug);

        /**
         * Sets whether to collect parameter names of abstract methods for FernFlower. Defaults to {@code true}.
         * @param collectAbstractParams whether to collect parameter names of abstract methods for FernFlower
         * @return this builder
         */
        Builder setCollectAbstractParams(boolean collectAbstractParams);

        /**
         * Builds the {@link Renamer} instance based on this configured builder.
         * The built Renamer is guaranteed to be reusable for multiple runs.
         *
         * @return the built {@link Renamer}
         */
        Renamer build();
    }
}