fix: resolve issues with incorrect labels and metadata

Author: skylot

.gitignore

@@ -33,4 +33,4 @@ node_modules/
 
 **/.DS_Store
 
-cliff.toml
+cliff.toml

raung-asm/src/main/java/io/github/skylot/raung/asm/impl/utils/ValidateAsmArgs.java

@@ -30,7 +30,7 @@ public static void process(RaungAsmBuilder args) {
 	}
 
 	public static void processOptions(RaungAsmBuilder args) {
-		LOG.debug("Effective args: {}", args);
+		LOG.trace("Effective args: {}", args);
 	}
 
 	private static Path getOutDirFromInputs(List<Path> inputs) {

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/utils/ListUtils.java

@@ -0,0 +1,20 @@
+package io.github.skylot.raung.disasm.impl.utils;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.jetbrains.annotations.Nullable;
+
+public class ListUtils {
+
+	public static <T> List<T> fromNullable(@Nullable List<T> list) {
+		return list == null ? Collections.emptyList() : list;
+	}
+
+	public static <T> List<T> addToNullable(@Nullable List<T> list, T obj) {
+		List<T> result = list == null ? new ArrayList<>() : list;
+		result.add(obj);
+		return result;
+	}
+}

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/utils/RaungWriter.java

@@ -4,7 +4,7 @@
 
 @SuppressWarnings("UnusedReturnValue")
 public class RaungWriter {
-	public static final String NL = System.getProperty("line.separator");
+	public static final String NL = System.lineSeparator();
 	public static final String INDENT_STR = "  ";
 
 	private final StringBuilder sb = new StringBuilder();

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/utils/ValidateDisasmArgs.java

@@ -27,6 +27,6 @@ public static void processOptions(RaungDisasmBuilder args) {
 		if (args.isAutoFrames()) {
 			args.autoMax(true);
 		}
-		LOG.debug("Effective args: {}", args);
+		LOG.trace("Effective args: {}", args);
 	}
 }

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/visitors/RaungClassVisitor.java

@@ -159,7 +159,7 @@ public MethodVisitor visitMethod(int access, String name, String descriptor,
 		if (signature != null) {
 			writer.startLine(Directive.SIGNATURE).add(signature);
 		}
-		return new RaungMethodVisitor(this);
+		return new RaungMethodVisitor(this, name + descriptor);
 	}
 
 	@Override
@@ -186,4 +186,9 @@ public String getClsFullName() {
 	public String getResult() {
 		return writer.getCode();
 	}
+
+	@Override
+	public String toString() {
+		return clsFullName;
+	}
 }

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/visitors/RaungMethodVisitor.java

@@ -5,7 +5,6 @@
 import java.util.IdentityHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.stream.Collectors;
 
 import org.objectweb.asm.AnnotationVisitor;
 import org.objectweb.asm.Attribute;
@@ -30,6 +29,7 @@
 public class RaungMethodVisitor extends MethodVisitor {
 	private final RaungClassVisitor classVisitor;
 	private final RaungWriter writer;
+	private final String mthShortId;
 
 	private final RaungWriter tempWriter = new RaungWriter();
 
@@ -39,10 +39,11 @@ public class RaungMethodVisitor extends MethodVisitor {
 
 	private int catchCount;
 
-	public RaungMethodVisitor(RaungClassVisitor classVisitor) {
+	public RaungMethodVisitor(RaungClassVisitor classVisitor, String mthShortId) {
 		super(classVisitor.getApi());
 		this.classVisitor = classVisitor;
 		this.writer = classVisitor.getWriter();
+		this.mthShortId = mthShortId;
 	}
 
 	@Override
@@ -69,11 +70,13 @@ public AnnotationVisitor visitTypeAnnotation(int typeRef, TypePath typePath, Str
 
 	@Override
 	public AnnotationVisitor visitInsnAnnotation(int typeRef, TypePath typePath, String descriptor, boolean visible) {
-		RaungWriter rw = new RaungWriter().setIndent(writer.getIndent());
-		RaungAnnotationVisitor av = RaungAnnotationVisitor.buildInsnAnnotation(classVisitor, rw, typeRef, typePath, descriptor, visible);
 		// attach annotation to last instruction
-		insnAttachments.put(insns.size() - 1, rw);
-		return av;
+		int insn = insns.size() - 1;
+		if (insn < 0) {
+			throw new RaungDisasmException("No instructions to attach annotation");
+		}
+		RaungWriter rw = insnAttachments.computeIfAbsent(insn, i -> new RaungWriter().setIndent(writer.getIndent()));
+		return RaungAnnotationVisitor.buildInsnAnnotation(classVisitor, rw, typeRef, typePath, descriptor, visible);
 	}
 
 	@Override
@@ -312,14 +315,16 @@ public AnnotationVisitor visitLocalVariableAnnotation(int typeRef, TypePath type
 	@Override
 	public void visitLineNumber(int line, Label start) {
 		if (addDebugInfo()) {
-			insns.add(".line " + line);
+			LabelData ld = getLabelData(start);
+			ld.setLine(line);
 		}
 	}
 
 	@Override
 	public void visitLabel(Label label) {
 		LabelData ld = getLabelData(label);
-		ld.setInsnRef(insns.size());
+		ld.setInsnRef(insns.size()); // for next insn
+		// System.out.println("DISASM visit label: " + ld);
 	}
 
 	@Override
@@ -334,23 +339,31 @@ public void visitMaxs(int maxStack, int maxLocals) {
 
 	@Override
 	public void visitEnd() {
-		Map<Integer, LabelData> labelsMap = labels.values().stream()
-				.filter(LabelData::isUsed)
-				.collect(Collectors.toMap(LabelData::getInsnRef, ld -> ld));
-		int insnsCount = insns.size();
-		for (int i = 0; i < insnsCount; i++) {
-			LabelData labelData = labelsMap.get(i);
-			if (labelData != null) {
-				handleLabelDataBeforeInsn(labelData);
+		try {
+			Map<Integer, LabelData> labelsMap = new HashMap<>();
+			for (LabelData ld : labels.values()) {
+				LabelData prevLabel = labelsMap.put(ld.getInsnRef(), ld);
+				if (prevLabel != null) {
+					throw new RaungDisasmException("Duplicate label, " + ld + ", prev: " + prevLabel);
+				}
 			}
-			addInsnAttachments(i);
-			writer.startLine(insns.get(i));
-			if (labelData != null) {
-				handleLabelDataAfterInsn(labelData, i == insnsCount - 1);
+			int insnsCount = insns.size();
+			for (int i = 0; i < insnsCount; i++) {
+				LabelData labelData = labelsMap.get(i);
+				if (labelData != null) {
+					handleLabelDataBeforeInsn(labelData);
+				}
+				addInsnAttachments(i);
+				writer.startLine(insns.get(i));
+				if (labelData != null) {
+					handleLabelDataAfterInsn(labelData, i == insnsCount - 1);
+				}
 			}
+			writer.setIndent(0);
+			writer.startLine(".end method");
+		} catch (Exception e) {
+			throw new RaungDisasmException("Failed to process method: " + this, e);
 		}
-		writer.setIndent(0);
-		writer.startLine(".end method");
 	}
 
 	private void addInsnAttachments(int insnOffset) {
@@ -375,19 +388,20 @@ private void handleLabelDataBeforeInsn(LabelData labelData) {
 				writer.space().add(startVar.getSignature());
 			}
 		}
-		if (!labelData.getCatches().isEmpty()) {
-			for (TryCatchBlock catchBlock : labelData.getCatches()) {
-				String type = catchBlock.getType();
-				writer.startLine(Directive.CATCH);
-				if (classVisitor.getArgs().isSaveCatchNumber()) {
-					writer.add('@').add(catchBlock.getId()).space();
-				}
-				writer.add(type == null ? "all" : type)
-						.space().add(catchBlock.getStart().getName())
-						.space().add("..")
-						.space().add(catchBlock.getEnd().getName())
-						.space().add("goto").space().add(catchBlock.getHandler().getName());
+		for (TryCatchBlock catchBlock : labelData.getCatches()) {
+			String type = catchBlock.getType();
+			writer.startLine(Directive.CATCH);
+			if (classVisitor.getArgs().isSaveCatchNumber()) {
+				writer.add('@').add(catchBlock.getId()).space();
 			}
+			writer.add(type == null ? "all" : type)
+					.space().add(catchBlock.getStart().getName())
+					.space().add("..")
+					.space().add(catchBlock.getEnd().getName())
+					.space().add("goto").space().add(catchBlock.getHandler().getName());
+		}
+		for (Integer line : labelData.getLines()) {
+			writer.startLine(".line ").add(line);
 		}
 	}
 
@@ -414,4 +428,9 @@ private RaungWriter formatInsn(int opcode) {
 	private boolean addDebugInfo() {
 		return !classVisitor.getArgs().isIgnoreDebugInfo();
 	}
+
+	@Override
+	public String toString() {
+		return classVisitor + "->" + mthShortId;
+	}
 }

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/visitors/data/LabelData.java

@@ -1,19 +1,21 @@
 package io.github.skylot.raung.disasm.impl.visitors.data;
 
-import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 
+import org.jetbrains.annotations.Nullable;
 import org.objectweb.asm.Label;
 
+import io.github.skylot.raung.disasm.impl.utils.ListUtils;
+
 public class LabelData {
 	private final Label label;
 	private final String name;
 	private int insnRef;
 	private int useCount;
-	private List<LocalVar> startVars;
-	private List<LocalVar> endVars;
-	private List<TryCatchBlock> catches;
+	private @Nullable List<LocalVar> startVars;
+	private @Nullable List<LocalVar> endVars;
+	private @Nullable List<TryCatchBlock> catches;
+	private @Nullable List<Integer> lines;
 
 	public LabelData(Label label, String name) {
 		this.label = label;
@@ -46,42 +48,39 @@ public LabelData addUse() {
 	}
 
 	public List<LocalVar> getStartVars() {
-		return startVars == null ? Collections.emptyList() : startVars;
+		return ListUtils.fromNullable(startVars);
 	}
 
 	public void addStartVars(LocalVar var) {
-		if (startVars == null) {
-			startVars = new ArrayList<>();
-		}
-		startVars.add(var);
+		this.startVars = ListUtils.addToNullable(startVars, var);
 	}
 
 	public List<LocalVar> getEndVars() {
-		return endVars == null ? Collections.emptyList() : endVars;
+		return ListUtils.fromNullable(endVars);
 	}
 
 	public void addEndVar(LocalVar var) {
-		if (endVars == null) {
-			endVars = new ArrayList<>();
-		}
-		endVars.add(var);
+		this.endVars = ListUtils.addToNullable(endVars, var);
 	}
 
 	public List<TryCatchBlock> getCatches() {
-		return catches == null ? Collections.emptyList() : catches;
+		return ListUtils.fromNullable(catches);
 	}
 
 	public void addCatch(TryCatchBlock block) {
-		if (catches == null) {
-			catches = new ArrayList<>();
-		}
-		catches.add(block);
+		this.catches = ListUtils.addToNullable(catches, block);
+	}
+
+	public List<Integer> getLines() {
+		return ListUtils.fromNullable(lines);
+	}
+
+	public void setLine(int line) {
+		this.lines = ListUtils.addToNullable(lines, line);
 	}
 
-	public boolean isUsed() {
-		return getUseCount() != 0
-				|| !getStartVars().isEmpty()
-				|| !getEndVars().isEmpty()
-				|| !getCatches().isEmpty();
+	@Override
+	public String toString() {
+		return name + " at " + insnRef;
 	}
 }

raung-disasm/src/main/java/io/github/skylot/raung/disasm/impl/visitors/data/LocalVar.java

@@ -28,4 +28,9 @@ public String getType() {
 	public String getSignature() {
 		return signature;
 	}
+
+	@Override
+	public String toString() {
+		return name + " : " + type;
+	}
 }

raung-tests/build.gradle.kts

@@ -7,4 +7,5 @@ dependencies {
 	testImplementation(project(":raung-disasm"))
 
 	testCompileOnly("org.jetbrains:annotations:24.1.0")
+	testImplementation("commons-io:commons-io:2.15.1")
 }