hibiscus-client/fabric-loom
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Revert "Add mixins that target the class as a comment. (#168)"

Browse source 
This reverts commit fb3c2c86
This commit is contained in:
modmuss50 2020-01-01 19:23:27 +00:00
parent fb3c2c86cb
commit cd202f2804
4 changed files with 3 additions and 274 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/main/java/net/fabricmc/loom/task/fernflower/FernFlowerTask.java
View file

@ -26,8 +26,6 @@ package net.fabricmc.loom.task.fernflower;
import static java.text.MessageFormat.format; import static java.text.MessageFormat.format;
import java.io.File;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
@ -35,7 +33,6 @@ import java.util.Map;
import java.util.Stack; import java.util.Stack;
import java.util.function.Supplier; import java.util.function.Supplier;
import org.apache.commons.io.FileUtils;
import org.jetbrains.java.decompiler.main.extern.IFernflowerPreferences; import org.jetbrains.java.decompiler.main.extern.IFernflowerPreferences;
import org.gradle.api.internal.project.ProjectInternal; import org.gradle.api.internal.project.ProjectInternal;
import org.gradle.api.logging.LogLevel; import org.gradle.api.logging.LogLevel;
@ -50,9 +47,6 @@ import net.fabricmc.loom.task.AbstractDecompileTask;
import net.fabricmc.loom.task.ForkingJavaExecTask; import net.fabricmc.loom.task.ForkingJavaExecTask;
import net.fabricmc.loom.util.ConsumingOutputStream; import net.fabricmc.loom.util.ConsumingOutputStream;
import net.fabricmc.loom.util.OperatingSystem; import net.fabricmc.loom.util.OperatingSystem;
import net.fabricmc.loom.util.Constants;
import net.fabricmc.loom.util.MixinTargetScanner;
import net.fabricmc.loom.util.RemappedConfigurationEntry;
/** /**
* Created by covers1624 on 9/02/19. * Created by covers1624 on 9/02/19.
@ -67,16 +61,6 @@ public class FernFlowerTask extends AbstractDecompileTask implements ForkingJava
throw new UnsupportedOperationException("FernFlowerTask requires a 64bit JVM to run due to the memory requirements"); throw new UnsupportedOperationException("FernFlowerTask requires a 64bit JVM to run due to the memory requirements");
} }
MixinTargetScanner mixinTargetScanner = new MixinTargetScanner(getProject());
for (RemappedConfigurationEntry modCompileEntry : Constants.MOD_COMPILE_ENTRIES) {
mixinTargetScanner.scan(getProject().getConfigurations().getByName(modCompileEntry.getRemappedConfiguration()));
}
String mixinTargetJson = mixinTargetScanner.getClassMixinsJson();
File mixinTargetFile = new File(getExtension().getProjectBuildCache(), "mixin_targets.json");
FileUtils.writeStringToFile(mixinTargetFile, mixinTargetJson, StandardCharsets.UTF_8);
Map<String, Object> options = new HashMap<>(); Map<String, Object> options = new HashMap<>();
options.put(IFernflowerPreferences.DECOMPILE_GENERIC_SIGNATURES, "1"); options.put(IFernflowerPreferences.DECOMPILE_GENERIC_SIGNATURES, "1");
options.put(IFernflowerPreferences.BYTECODE_SOURCE_MAPPING, "1"); options.put(IFernflowerPreferences.BYTECODE_SOURCE_MAPPING, "1");
@ -96,7 +80,6 @@ public class FernFlowerTask extends AbstractDecompileTask implements ForkingJava
args.add("-t=" + getNumThreads()); args.add("-t=" + getNumThreads());
args.add("-m=" + getExtension().getMappingsProvider().tinyMappings.getAbsolutePath()); args.add("-m=" + getExtension().getMappingsProvider().tinyMappings.getAbsolutePath());
args.add("-j=" + mixinTargetFile.getAbsolutePath());
//TODO, Decompiler breaks on jemalloc, J9 module-info.class? //TODO, Decompiler breaks on jemalloc, J9 module-info.class?
getLibraries().forEach(f -> args.add("-e=" + f.getAbsolutePath())); getLibraries().forEach(f -> args.add("-e=" + f.getAbsolutePath()));

9
src/main/java/net/fabricmc/loom/task/fernflower/ForkedFFExecutor.java
View file

@ -52,7 +52,6 @@ public class ForkedFFExecutor {
File output = null; File output = null;
File lineMap = null; File lineMap = null;
File mappings = null; File mappings = null;
File mixins = null;
List<File> libraries = new ArrayList<>(); List<File> libraries = new ArrayList<>();
int numThreads = 0; int numThreads = 0;
@ -92,12 +91,6 @@ public class ForkedFFExecutor {
} }
mappings = new File(arg.substring(3)); mappings = new File(arg.substring(3));
} else if (arg.startsWith("-j=")) {
if (mixins != null) {
throw new RuntimeException("Unable to use more than one mixin file.");
}
mixins = new File(arg.substring(3));
} else if (arg.startsWith("-t=")) { } else if (arg.startsWith("-t=")) {
numThreads = Integer.parseInt(arg.substring(3)); numThreads = Integer.parseInt(arg.substring(3));
} else { } else {
@ -114,7 +107,7 @@ public class ForkedFFExecutor {
Objects.requireNonNull(output, "Output not set."); Objects.requireNonNull(output, "Output not set.");
Objects.requireNonNull(mappings, "Mappings not set."); Objects.requireNonNull(mappings, "Mappings not set.");
options.put(IFabricJavadocProvider.PROPERTY_NAME, new TinyJavadocProvider(mappings, mixins)); options.put(IFabricJavadocProvider.PROPERTY_NAME, new TinyJavadocProvider(mappings));
runFF(options, libraries, input, output, lineMap); runFF(options, libraries, input, output, lineMap);
} }

35
src/main/java/net/fabricmc/loom/task/fernflower/TinyJavadocProvider.java
View file

@ -27,14 +27,12 @@ package net.fabricmc.loom.task.fernflower;
import java.io.BufferedReader; import java.io.BufferedReader;
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files; import java.nio.file.Files;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import org.apache.commons.io.FileUtils;
import org.jetbrains.java.decompiler.struct.StructClass; import org.jetbrains.java.decompiler.struct.StructClass;
import org.jetbrains.java.decompiler.struct.StructField; import org.jetbrains.java.decompiler.struct.StructField;
import org.jetbrains.java.decompiler.struct.StructMethod; import org.jetbrains.java.decompiler.struct.StructMethod;
@ -47,18 +45,15 @@ import net.fabricmc.mapping.tree.ParameterDef;
import net.fabricmc.mapping.tree.TinyMappingFactory; import net.fabricmc.mapping.tree.TinyMappingFactory;
import net.fabricmc.mapping.tree.TinyTree; import net.fabricmc.mapping.tree.TinyTree;
import net.fabricmc.mappings.EntryTriple; import net.fabricmc.mappings.EntryTriple;
import net.fabricmc.loom.util.MixinTargetScanner;
public class TinyJavadocProvider implements IFabricJavadocProvider { public class TinyJavadocProvider implements IFabricJavadocProvider {
private final Map<String, ClassDef> classes = new HashMap<>(); private final Map<String, ClassDef> classes = new HashMap<>();
private final Map<EntryTriple, FieldDef> fields = new HashMap<>(); private final Map<EntryTriple, FieldDef> fields = new HashMap<>();
private final Map<EntryTriple, MethodDef> methods = new HashMap<>(); private final Map<EntryTriple, MethodDef> methods = new HashMap<>();
private final Map<String, List<MixinTargetScanner.MixinTargetInfo>> mixins;
private final String namespace = "named"; private final String namespace = "named";
public TinyJavadocProvider(File tinyFile, File mixinTargetFile) { public TinyJavadocProvider(File tinyFile) {
final TinyTree mappings = readMappings(tinyFile); final TinyTree mappings = readMappings(tinyFile);
for (ClassDef classDef : mappings.getClasses()) { for (ClassDef classDef : mappings.getClasses()) {
@ -73,38 +68,12 @@ public class TinyJavadocProvider implements IFabricJavadocProvider {
methods.put(new EntryTriple(className, methodDef.getName(namespace), methodDef.getDescriptor(namespace)), methodDef); methods.put(new EntryTriple(className, methodDef.getName(namespace), methodDef.getDescriptor(namespace)), methodDef);
} }
} }
try {
mixins = MixinTargetScanner.fromJson(FileUtils.readFileToString(mixinTargetFile, StandardCharsets.UTF_8));
} catch (IOException e) {
throw new RuntimeException("Failed to read mixin target file", e);
}
} }
@Override @Override
public String getClassDoc(StructClass structClass) { public String getClassDoc(StructClass structClass) {
StringBuilder comment = new StringBuilder();
ClassDef classDef = classes.get(structClass.qualifiedName); ClassDef classDef = classes.get(structClass.qualifiedName);
return classDef != null ? classDef.getComment() : null;
if (classDef != null && classDef.getComment() != null) {
comment.append(classDef.getComment());
}
if (mixins.containsKey(structClass.qualifiedName)) {
List<MixinTargetScanner.MixinTargetInfo> mixinList = mixins.get(structClass.qualifiedName);
if (classDef != null && classDef.getComment() != null) {
comment.append("\n");
}
comment.append("Mixins:");
for (MixinTargetScanner.MixinTargetInfo info : mixinList) {
comment.append(String.format("\n\t%s - {@link %s}", info.getModid(), info.getMixinClass().replaceAll("\\$", ".")));
}
}
return comment.length() == 0 ? null : comment.toString();
} }
@Override @Override

216
src/main/java/net/fabricmc/loom/util/MixinTargetScanner.java
View file

@ -1,216 +0,0 @@
/*
* This file is part of fabric-loom, licensed under the MIT License (MIT).
*
* Copyright (c) 2016, 2017, 2018 FabricMC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.fabricmc.loom.util;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;
import com.google.common.reflect.TypeToken;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import org.apache.commons.io.IOUtils;
import org.gradle.api.Project;
import org.gradle.api.artifacts.Configuration;
import org.objectweb.asm.ClassReader;
import org.objectweb.asm.Type;
import org.objectweb.asm.tree.AnnotationNode;
import org.objectweb.asm.tree.ClassNode;
public class MixinTargetScanner {
private static final Gson GSON = new GsonBuilder().setPrettyPrinting().create();
private final Project project;
private HashMap<String, List<MixinTargetInfo>> classMixins = new HashMap<>();
private List<String> scannedMods = new ArrayList<>();
public MixinTargetScanner(Project project) {
this.project = project;
}
public void scan(Configuration configuration) {
Set<File> filesToScan = configuration.getResolvedConfiguration().getFiles();
filesToScan.forEach(this::scanFile);
}
private void scanFile(File file) {
try (ZipFile zipFile = new ZipFile(file)) {
ZipEntry modJsonEntry = zipFile.getEntry("fabric.mod.json");
if (modJsonEntry != null) {
try (InputStream is = zipFile.getInputStream(modJsonEntry)) {
JsonObject jsonObject = GSON.fromJson(new InputStreamReader(is), JsonObject.class);
scanMod(zipFile, jsonObject);
}
} else {
project.getLogger().lifecycle("Could not find mod json in " + file.getName());
}
} catch (ZipException e) {
// Ignore this, most likely an invalid zip
} catch (IOException e) {
throw new RuntimeException("Failed to scan zip file ", e);
}
}
private void scanMod(ZipFile zipFile, JsonObject modInfo) throws IOException {
if (!modInfo.has("mixins")) return;
JsonArray mixinsJsonArray = modInfo.getAsJsonArray("mixins");
String modId = modInfo.get("id").getAsString();
List<String> mixins = new ArrayList<>();
List<String> mixinClasses = new ArrayList<>();
//Make sure we dont scan the same mod twice, I dont think this is possible just want to be sure
if (scannedMods.contains(modId)) return;
scannedMods.add(modId);
for (int i = 0; i < mixinsJsonArray.size(); i++) {
mixins.add(mixinsJsonArray.get(i).getAsString());
}
//Find all the mixins in the jar
for (String mixin : mixins) {
ZipEntry mixinZipEntry = zipFile.getEntry(mixin);
if (mixinZipEntry == null) continue;
try (InputStream is = zipFile.getInputStream(mixinZipEntry)) {
JsonObject jsonObject = GSON.fromJson(new InputStreamReader(is), JsonObject.class);
readMixinClasses(jsonObject, mixinClasses);
}
}
for (String mixinClass : mixinClasses) {
ZipEntry mixinZipEntry = zipFile.getEntry(mixinClass.replaceAll("\\.", "/") + ".class");
if (mixinZipEntry == null) {
project.getLogger().info("Failed to find mixin class: " + mixinClass);
continue;
}
try (InputStream is = zipFile.getInputStream(mixinZipEntry)) {
byte[] classBytes = IOUtils.toByteArray(is);
List<String> mixinTargets = readMixinClass(classBytes);
for (String mixinTarget : mixinTargets) {
classMixins.computeIfAbsent(mixinTarget, s -> new ArrayList<>())
.add(new MixinTargetInfo(mixinClass, modId));
}
}
}
}
private void readMixinClasses(JsonObject jsonObject, List<String> mixinClasses) {
String[] sides = new String[]{"mixins", "client", "server"};
if (!jsonObject.has("package")) return;
String mixinPackage = jsonObject.getAsJsonPrimitive("package").getAsString();
for (String side : sides) {
if (!jsonObject.has(side)) continue;
JsonArray jsonArray = jsonObject.getAsJsonArray(side);
for (int i = 0; i < jsonArray.size(); i++) {
String mixinClass = jsonArray.get(i).getAsString();
mixinClasses.add(String.format("%s.%s", mixinPackage, mixinClass));
}
}
}
private List<String> readMixinClass(byte[] bytes) {
ClassNode classNode = new ClassNode();
ClassReader classReader = new ClassReader(bytes);
classReader.accept(classNode, 0);
if (classNode.invisibleAnnotations == null) return Collections.emptyList();
List<String> mixinTargets = new ArrayList<>();
for (AnnotationNode annotationNode : classNode.invisibleAnnotations) {
if (annotationNode.desc.equals("Lorg/spongepowered/asm/mixin/Mixin;")) {
List<Object> values = annotationNode.values;
for (int i = 0; i < values.size(); i++) {
if (values.get(i).equals("value")) {
//noinspection unchecked
List<Type> types = (List<Type>) values.get(i + 1);
for (Type type : types) {
mixinTargets.add(type.getInternalName());
}
}
}
break;
}
}
return mixinTargets;
}
public Map<String, List<MixinTargetInfo>> getClassMixins() {
return classMixins;
}
public String getClassMixinsJson() {
return GSON.toJson(getClassMixins());
}
public static Map<String, List<MixinTargetInfo>> fromJson(String input) {
return GSON.fromJson(input, new TypeToken<Map<String, List<MixinTargetInfo>>>() {
}.getType());
}
public static class MixinTargetInfo {
private final String mixinClass;
private final String modid;
public MixinTargetInfo(String mixinClass, String modid) {
this.mixinClass = mixinClass;
this.modid = modid;
}
public String getMixinClass() {
return mixinClass;
}
public String getModid() {
return modid;
}
}
}