Merge pull request #23 from FabricCompatibilityLayers/feature/api-v2

Api V2

Author: thecatcore

build.gradle

@@ -58,7 +58,7 @@ dependencies {
 
 	implementation(include("io.github.llamalad7:mixinextras-fabric:${project.mixin_extras_version}"))
 	implementation(include("com.github.thecatcore.CursedMixinExtensions:fabric:1.0.0"))
-	implementation(include("com.github.thecatcore:WFVAIO:1.1.0"))
+	implementation(include("com.github.thecatcore:WFVAIO:1.2.0"))
 
 	testImplementation "net.fabricmc:fabric-loader-junit:${project.loader_version}"
 }
@@ -163,3 +163,11 @@ Now allow ModRemappers to disable mixin remapping which is enabled by default fo
 		embedded.version "spasm", project.spasm_version
 	}
 }
+
+task testmodJar(type: Jar) {
+	from sourceSets.test.output
+	destinationDirectory = project.layout.buildDirectory.dir("libs")
+	archiveClassifier.set("testmod")
+}
+
+build.dependsOn testmodJar

gradle.properties

@@ -6,7 +6,7 @@ org.gradle.jvmargs=-Xmx1G
 # Fabric Properties
 	minecraft_version = 1.6.4
 	yarn_build = 458
-	loader_version = 0.15.10
+	loader_version = 0.16.11
 	fabric_version = 1.9.1+1.12.2
 	mixin_extras_version=0.2.1
 	spasm_version=0.2

src/main/java/fr/catcore/modremapperapi/utils/Constants.java

@@ -6,13 +6,20 @@
 import java.io.File;
 
 public class Constants {
+    @Deprecated
     public static final File MAIN_FOLDER = CacheUtils.BASE_FOLDER.toFile();
+    @Deprecated
     public static final File VERSIONED_FOLDER = CacheUtils.MAIN_FOLDER.toFile();
+    @Deprecated
     public static final File LIB_FOLDER = CacheUtils.LIBRARY_FOLDER.toFile();
 
+    @Deprecated
     public static final File EXTRA_MAPPINGS_FILE = CacheUtils.getCachePath("extra_mappings.tiny").toFile();
+    @Deprecated
     public static final File REMAPPED_MAPPINGS_FILE = CacheUtils.getCachePath("remapped_mappings.tiny").toFile();
+    @Deprecated
     public static final File MC_MAPPINGS_FILE = CacheUtils.getCachePath("mc_mappings.tiny").toFile();
+    @Deprecated
     public static final File FULL_MAPPINGS_FILE = CacheUtils.getCachePath("full_mappings.tiny").toFile();
 
     public static final Logger MAIN_LOGGER = Logger.get("ModRemappingAPI");

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/CacheHandler.java

@@ -0,0 +1,15 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import io.github.fabriccompatibiltylayers.modremappingapi.impl.context.BaseModRemapperContext;
+
+import java.nio.file.Path;
+
+public interface CacheHandler {
+    Path resolveTemp(String name);
+    Path resolveCache(String name);
+    Path resolveLibrary(String name);
+
+    static CacheHandler getCacheHandler(String contextId) {
+        return BaseModRemapperContext.get(contextId).getCacheHandler();
+    }
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/MappingBuilder.java

@@ -0,0 +1,14 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+public interface MappingBuilder {
+
+    ClassMapping addMapping(String sourceName, String targetName);
+    ClassMapping addMapping(String name);
+
+    public interface ClassMapping {
+        ClassMapping field(String sourceName, String targetName, String sourceDescriptor);
+        ClassMapping field(String name, String descriptor);
+        ClassMapping method(String sourceName, String targetName, String sourceDescriptor);
+        ClassMapping method(String name, String descriptor);
+    }
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/MappingUtils.java

@@ -0,0 +1,90 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import io.github.fabriccompatibiltylayers.modremappingapi.impl.MappingsUtilsImpl;
+import org.jetbrains.annotations.Nullable;
+
+public interface MappingUtils {
+    /**
+     *
+     * @param className original class name
+     * @return remapped class name
+     */
+    static String mapClass(String contextId, String className) {
+        return MappingsUtilsImpl.mapClass(MappingsUtilsImpl.getMappingsRegistry(contextId), className);
+    }
+
+    /**
+     *
+     * @param className remapped class name
+     * @return original class name
+     */
+    static String unmapClass(String contextId, String className) {
+        return MappingsUtilsImpl.unmapClass(MappingsUtilsImpl.getMappingsRegistry(contextId), className);
+    }
+
+    /**
+     *
+     * @param className original class name
+     * @param fieldName
+     * @param fieldDesc
+     * @return
+     */
+    static ClassMember mapField(String contextId, String className, String fieldName, @Nullable String fieldDesc) {
+        return MappingsUtilsImpl.mapField(MappingsUtilsImpl.getMappingsRegistry(contextId), className, fieldName, fieldDesc);
+    }
+
+    /**
+     *
+     * @param className remapped class name
+     * @param fieldName
+     * @param fieldDesc
+     * @return
+     */
+    static ClassMember mapFieldFromRemappedClass(String contextId, String className, String fieldName, @Nullable String fieldDesc) {
+        return MappingsUtilsImpl.mapFieldFromRemappedClass(MappingsUtilsImpl.getMappingsRegistry(contextId), className, fieldName, fieldDesc);
+    }
+
+    /**
+     *
+     * @param className original class name
+     * @param methodName
+     * @param methodDesc
+     * @return
+     */
+    static ClassMember mapMethod(String contextId, String className, String methodName, String methodDesc) {
+        return MappingsUtilsImpl.mapMethod(MappingsUtilsImpl.getMappingsRegistry(contextId), className, methodName, methodDesc);
+    }
+
+    /**
+     *
+     * @param className remapped class name
+     * @param methodName
+     * @param methodDesc
+     * @return
+     */
+    static ClassMember mapMethodFromRemappedClass(String contextId, String className, String methodName, String methodDesc) {
+        return MappingsUtilsImpl.mapMethodFromRemappedClass(MappingsUtilsImpl.getMappingsRegistry(contextId), className, methodName, methodDesc);
+    }
+
+    static ClassMember mapField(String contextId, Class<?> owner, String fieldName) {
+        return MappingsUtilsImpl.mapField(MappingsUtilsImpl.getMappingsRegistry(contextId), owner, fieldName);
+    }
+
+    static ClassMember mapMethod(String contextId, Class<?> owner, String methodName, Class<?>[] parameterTypes) {
+        return MappingsUtilsImpl.mapMethod(MappingsUtilsImpl.getMappingsRegistry(contextId), owner, methodName, parameterTypes);
+    }
+
+    /**
+     *
+     * @param desc original descriptor
+     * @return remapped descriptor
+     */
+    static String mapDescriptor(String contextId, String desc) {
+        return MappingsUtilsImpl.mapDescriptor(MappingsUtilsImpl.getMappingsRegistry(contextId), desc);
+    }
+
+    interface ClassMember {
+        String getName();
+        @Nullable String getDesc();
+    }
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/MappingsConfig.java

@@ -0,0 +1,18 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import io.github.fabriccompatibilitylayers.modremappingapi.impl.DefaultMappingsConfig;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Map;
+import java.util.function.Supplier;
+
+public interface MappingsConfig {
+    @Nullable String getSourceNamespace();
+    @Nullable Supplier<String> getExtraMappings();
+    Map<String, String> getRenamingMap();
+    @Nullable String getDefaultPackage();
+
+    static MappingsConfig defaultConfig() {
+        return new DefaultMappingsConfig();
+    }
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/ModCandidate.java

@@ -0,0 +1,22 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import org.jetbrains.annotations.Nullable;
+
+import java.nio.file.Path;
+
+public interface ModCandidate {
+    String getId();
+    Path getPath();
+    String getType();
+    @Nullable String getAccessWidenerPath();
+    @Nullable ModCandidate getParent();
+    @Nullable String getVersion();
+    @Nullable String getParentSubPath();
+    String getDestinationName();
+    ModDiscovererConfig getDiscovererConfig();
+    void setAccessWidener(byte[] data);
+    byte @Nullable [] getAccessWidener();
+    void setDestination(Path destination);
+    @Nullable Path getDestination();
+    void setPath(Path path);
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/ModDiscovererConfig.java

@@ -0,0 +1,39 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import io.github.fabriccompatibilitylayers.modremappingapi.impl.ModDiscovererConfigImpl;
+
+import java.nio.file.Path;
+import java.util.List;
+import java.util.function.BiFunction;
+import java.util.function.Predicate;
+import java.util.regex.Pattern;
+
+public interface ModDiscovererConfig {
+    static Builder builder(String folderName) {
+        return new ModDiscovererConfigImpl.BuilderImpl(folderName);
+    }
+
+    String getFolderName();
+    Pattern getFileNameMatcher();
+    boolean searchRecursively();
+    Predicate<String> getDirectoryFilter();
+    Collector getCandidateCollector();
+    boolean getExportToOriginalFolder();
+    boolean allowDirectoryMods();
+
+    interface Builder {
+        Builder fileNameMatcher(String pattern);
+        Builder searchRecursively(boolean searchRecursively);
+        Builder directoryFilter(Predicate<String> filter);
+        Builder candidateCollector(Collector collector);
+        Builder exportToOriginalFolder(boolean exportToOriginalFolder);
+        Builder allowDirectoryMods(boolean allowDirectoryMods);
+
+        ModDiscovererConfig build();
+    }
+
+    @FunctionalInterface
+    interface Collector {
+        List<ModCandidate> collect(ModDiscovererConfig config, Path modPath, List<String> entries);
+    }
+}

src/main/java/io/github/fabriccompatibilitylayers/modremappingapi/api/v2/ModRemapper.java

@@ -0,0 +1,23 @@
+package io.github.fabriccompatibilitylayers.modremappingapi.api.v2;
+
+import net.fabricmc.api.EnvType;
+
+import java.util.List;
+
+public interface ModRemapper {
+    String getContextId();
+
+    void init(CacheHandler cacheHandler);
+
+    List<ModDiscovererConfig> getModDiscoverers();
+    List<ModRemapper> collectSubRemappers(List<ModCandidate> discoveredMods);
+    MappingsConfig getMappingsConfig();
+    List<RemappingFlags> getRemappingFlags();
+    void afterRemapping();
+    void afterAllRemappings();
+
+    void addRemappingLibraries(List<RemapLibrary> libraries, EnvType environment);
+    void registerAdditionalMappings(MappingBuilder mappingBuilder);
+    void registerPreVisitors(VisitorInfos visitorInfos);
+    void registerPostVisitors(VisitorInfos visitorInfos);
+}