7903546: jdec,jdis: Enhance decompiler outputs flexibility and readability. (openjdk#64)

Author: lkuskov

build/productinfo.properties

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2022, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2014, 2023, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # This code is free software; you can redistribute it and/or modify it
@@ -27,5 +27,5 @@ PRODUCT_NAME        = asmtools
 PRODUCT_JAR_NAME    = asmtools.jar
 PRODUCT_VERSION     = 8.0
 PRODUCT_MILESTONE   = ea
-PRODUCT_BUILDNUMBER = 05
+PRODUCT_BUILDNUMBER = 06
 PRODUCT_NAME_LONG   = Java Assembler Tools

src/org/openjdk/asmtools/common/outputs/TextOutput.java

@@ -29,9 +29,16 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Optional;
+import java.util.function.BiFunction;
 import java.util.stream.Collectors;
 
+import static java.lang.String.format;
+
 public class TextOutput extends NamedToolOutput {
+
+    // decoration for text output
+    private BiFunction<String, String, String> namedSourceOrnament = null;
+
     private final ArrayList<NamedSource> outputs = new ArrayList<>();
     private StringBuilder currentClass;
 
@@ -46,7 +53,7 @@ public String toString() {
 
     @Override
     public DataOutputStream getDataOutputStream() throws FileNotFoundException {
-        return null; //If you are here, you probably wanted ToolOutput.ByteOutput for assmbled binary output
+        return null; //If you are here, you probably wanted ToolOutput.ByteOutput for assembled binary output
     }
 
     @Override
@@ -56,14 +63,18 @@ public void startClass(String fullyQualifiedName, Optional<String> suffix, Envir
     }
 
     @Override
-    public void finishClass(String fqn) throws IOException {
-        if (!getCurrentClassName().equals(fqn)) {
-            throw new RuntimeException("Ended different class - " + fqn + " - then started - " + super.fqn);
+    public void finishClass(String fullyQualifiedName) throws IOException {
+        if (!getCurrentClassName().equals(fullyQualifiedName)) {
+            throw new RuntimeException("Ended different class - " + fullyQualifiedName + " - then started - " + super.fqn);
         }
-        outputs.add(new NamedSource(fqn, currentClass.toString()));
+        outputs.add(new NamedSource(fullyQualifiedName, currentClass.toString(), namedSourceOrnament));
         super.fqn = null;
         currentClass = null;
+    }
 
+    public TextOutput setNamedSourceOrnament(BiFunction<String, String, String> namedSourceOrnament) {
+        this.namedSourceOrnament = namedSourceOrnament;
+        return this;
     }
 
     @Override
@@ -83,20 +94,42 @@ public void prints(char line) {
 
     @Override
     public void flush() {
-
     }
 
     public class NamedSource {
-        private final String fqn;
+        // decoration for text output
+        private BiFunction<String, String, String> ornament = (fname, body) ->
+                format(
+                        """
+                        /**
+                        %s
+                        **/
+                        %s
+                        /**
+                        %s
+                        **/        
+                        """, fname, body, fname);
+        private final String fullyQualifiedName;
         private final String body;
 
-        public NamedSource(String fqn, String body) {
-            this.fqn = fqn;
+        public NamedSource(String fullyQualifiedName, String body) {
+            this.fullyQualifiedName = fullyQualifiedName;
             this.body = body;
         }
 
-        public String getFqn() {
-            return fqn;
+        public NamedSource(String fullyQualifiedName, String body, BiFunction<String, String, String> ornament) {
+            this.fullyQualifiedName = fullyQualifiedName;
+            this.body = body;
+            this.ornament = ornament;
+        }
+
+        public NamedSource setOrnament(BiFunction<String, String, String> ornament) {
+            this.ornament = ornament;
+            return this;
+        }
+
+        public String getFullyQualifiedName() {
+            return fullyQualifiedName;
         }
 
         public String getBody() {
@@ -105,7 +138,7 @@ public String getBody() {
 
         @Override
         public String toString() {
-            return "/**********\n" + fqn + "\n**********/\n" + body + "\n/*end of " + fqn + "*/";
+            return ornament == null ? body : ornament.apply(fullyQualifiedName, body);
         }
     }
 }

src/org/openjdk/asmtools/jdis/InstructionAttr.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1996, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2023, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -213,13 +213,18 @@ public boolean printStackMap(int shift) {
             return false;
         }
         boolean printed = false;
+        int mapShift = getCommentOffset() - STACKMAP_TYPE_PLACEHOLDER_LENGTH - getIndentStep();
         if (stackMapEntry.stackFrameType != null) {
             printPadRight(Opcode.opc_stack_frame_type.parseKey(), STACKMAP_TYPE_PLACEHOLDER_LENGTH + 1);
-            println(stackMapEntry.stackFrameType.tagName() + ";");
+            if( printCPIndex && !skipComments ) {
+                print(PadRight(stackMapEntry.stackFrameType.tagName() + ";", mapShift)).
+                        println(" // frame_type " + stackMapEntry.stackFrameTypeValue);
+            } else {
+                println(stackMapEntry.stackFrameType.tagName() + ";");
+            }
             printed = true;
         }
         int[] map = stackMapEntry.lockMap;
-        int mapShift = getCommentOffset() - STACKMAP_TYPE_PLACEHOLDER_LENGTH - getIndentStep();
         if ((map != null) && (map.length > 0)) {
             Pair<String, String> line = getMapListAsString(map);
             if (stackMapEntry.type == STACKMAPTABLE) {  // StackMapTable exists

src/org/openjdk/asmtools/jdis/StackMapData.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1996, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1996, 2023, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -37,6 +37,8 @@
 class StackMapData extends MemberData<CodeData> {
     EAttributeType type;
     StackMap.FrameType stackFrameType = null;
+    // stack frame type value
+    int stackFrameTypeValue;
     int frame_pc;
     int offset;
     int[] lockMap;
@@ -61,52 +63,52 @@ public StackMapData(EAttributeType type, boolean firstStackMap, int prevFrame_pc
             environment.traceln(" stack_map_entry:pc=%d numloc=%s  numstack=%s",
                     frame_pc, mapToHexString(lockMap), mapToHexString(stackMap));
         } else { // if (type == EDataType.STACKMAPTABLE)
-            int ft_val = in.readUnsignedByte();
-            StackMap.FrameType frame_type = StackMap.stackMapFrameType(ft_val);
+            stackFrameTypeValue = in.readUnsignedByte();
+            StackMap.FrameType frame_type = StackMap.stackMapFrameType(stackFrameTypeValue);
             switch (frame_type) {
                 case SAME_FRAME -> {
                     // verificationType is same_frame;
-                    offset = ft_val;
-                    environment.traceln(" same_frame=%d", ft_val);
+                    offset = stackFrameTypeValue;
+                    environment.traceln(" same_frame=%d", stackFrameTypeValue);
                 }
                 case SAME_FRAME_EX -> {
                     // verificationType is same_frame_extended;
                     offset = in.readUnsignedShort();
-                    environment.traceln(" same_frame_extended=%d, offset=%d", ft_val, offset);
+                    environment.traceln(" same_frame_extended=%d, offset=%d", stackFrameTypeValue, offset);
                 }
                 case SAME_LOCALS_1_STACK_ITEM_FRAME -> {
                     // verificationType is same_locals_1_stack_item_frame
-                    offset = ft_val - 64;
+                    offset = stackFrameTypeValue - 64;
                     stackMap = readMapElements(in, 1);
                     environment.traceln(" same_locals_1_stack_item_frame=%d, offset=%d, numstack=%s",
-                            ft_val, offset, mapToHexString(stackMap));
+                            stackFrameTypeValue, offset, mapToHexString(stackMap));
                 }
                 case SAME_LOCALS_1_STACK_ITEM_EXTENDED_FRAME -> {
                     // verificationType is same_locals_1_stack_item_frame_extended
                     offset = in.readUnsignedShort();
                     stackMap = readMapElements(in, 1);
                     environment.traceln(" same_locals_1_stack_item_frame_extended=%d, offset=%d, numstack=%s",
-                            ft_val, offset, mapToHexString(stackMap));
+                            stackFrameTypeValue, offset, mapToHexString(stackMap));
                 }
                 case CHOP_1_FRAME, CHOP_2_FRAME, CHOP_3_FRAME -> {
                     // verificationType is chop_frame
                     offset = in.readUnsignedShort();
-                    environment.traceln(" chop_frame=%d offset=%d", ft_val, offset);
+                    environment.traceln(" chop_frame=%d offset=%d", stackFrameTypeValue, offset);
                 }
                 case APPEND_FRAME -> {
                     // verificationType is append_frame
                     offset = in.readUnsignedShort();
-                    lockMap = readMapElements(in, ft_val - 251);
+                    lockMap = readMapElements(in, stackFrameTypeValue - 251);
                     environment.traceln(" append_frame=%d offset=%d numlock=%s",
-                            ft_val, offset, mapToHexString(lockMap));
+                            stackFrameTypeValue, offset, mapToHexString(lockMap));
                 }
                 case FULL_FRAME -> {
                     // verificationType is full_frame
                     offset = in.readUnsignedShort();
                     lockMap = readMap(in);
                     stackMap = readMap(in);
                     environment.traceln(" full_frame=%d offset=%d numloc=%s  numstack=%s",
-                            ft_val, offset, mapToHexString(lockMap), mapToHexString(stackMap));
+                            stackFrameTypeValue, offset, mapToHexString(lockMap), mapToHexString(stackMap));
                 }
                 default -> environment.traceln("incorrect frame_type argument");
             }