You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2022/11/19 14:07:47 UTC

[commons-bcel] 01/02: Better local names

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bcel.git

commit b5697723df7284ef3371221415b9e4bf83e5ef1c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Nov 19 08:57:36 2022 -0500

    Better local names
---
 .../java/org/apache/bcel/classfile/Attribute.java  | 72 +++++++++++-----------
 .../java/org/apache/bcel/classfile/StackMap.java   |  8 +--
 .../org/apache/bcel/classfile/StackMapEntry.java   | 30 ++++-----
 3 files changed, 55 insertions(+), 55 deletions(-)

diff --git a/src/main/java/org/apache/bcel/classfile/Attribute.java b/src/main/java/org/apache/bcel/classfile/Attribute.java
index edd4ce1a..d1d38f40 100644
--- a/src/main/java/org/apache/bcel/classfile/Attribute.java
+++ b/src/main/java/org/apache/bcel/classfile/Attribute.java
@@ -93,20 +93,20 @@ public abstract class Attribute implements Cloneable, Node {
      * @see Field
      * @see Method
      *
-     * @param file Input stream
+     * @param dataInput Input stream
      * @param constantPool Array of constants
      * @return Attribute
      * @throws IOException if an I/O error occurs.
      * @since 6.0
      */
-    public static Attribute readAttribute(final DataInput file, final ConstantPool constantPool) throws IOException {
+    public static Attribute readAttribute(final DataInput dataInput, final ConstantPool constantPool) throws IOException {
         byte tag = Const.ATTR_UNKNOWN; // Unknown attribute
         // Get class name from constant pool via `name_index' indirection
-        final int nameIndex = file.readUnsignedShort();
+        final int nameIndex = dataInput.readUnsignedShort();
         final String name = constantPool.getConstantUtf8(nameIndex).getBytes();
 
         // Length of data in bytes
-        final int length = file.readInt();
+        final int length = dataInput.readInt();
 
         // Compare strings to find known attribute
         for (byte i = 0; i < Const.KNOWN_ATTRIBUTES; i++) {
@@ -121,68 +121,68 @@ public abstract class Attribute implements Cloneable, Node {
         case Const.ATTR_UNKNOWN:
             final Object r = READERS.get(name);
             if (r instanceof UnknownAttributeReader) {
-                return ((UnknownAttributeReader) r).createAttribute(nameIndex, length, file, constantPool);
+                return ((UnknownAttributeReader) r).createAttribute(nameIndex, length, dataInput, constantPool);
             }
-            return new Unknown(nameIndex, length, file, constantPool);
+            return new Unknown(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_CONSTANT_VALUE:
-            return new ConstantValue(nameIndex, length, file, constantPool);
+            return new ConstantValue(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_SOURCE_FILE:
-            return new SourceFile(nameIndex, length, file, constantPool);
+            return new SourceFile(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_CODE:
-            return new Code(nameIndex, length, file, constantPool);
+            return new Code(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_EXCEPTIONS:
-            return new ExceptionTable(nameIndex, length, file, constantPool);
+            return new ExceptionTable(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_LINE_NUMBER_TABLE:
-            return new LineNumberTable(nameIndex, length, file, constantPool);
+            return new LineNumberTable(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_LOCAL_VARIABLE_TABLE:
-            return new LocalVariableTable(nameIndex, length, file, constantPool);
+            return new LocalVariableTable(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_INNER_CLASSES:
-            return new InnerClasses(nameIndex, length, file, constantPool);
+            return new InnerClasses(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_SYNTHETIC:
-            return new Synthetic(nameIndex, length, file, constantPool);
+            return new Synthetic(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_DEPRECATED:
-            return new Deprecated(nameIndex, length, file, constantPool);
+            return new Deprecated(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_PMG:
-            return new PMGClass(nameIndex, length, file, constantPool);
+            return new PMGClass(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_SIGNATURE:
-            return new Signature(nameIndex, length, file, constantPool);
+            return new Signature(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_STACK_MAP:
             // old style stack map: unneeded for JDK5 and below;
             // illegal(?) for JDK6 and above. So just delete with a warning.
             println("Warning: Obsolete StackMap attribute ignored.");
-            return new Unknown(nameIndex, length, file, constantPool);
+            return new Unknown(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_RUNTIME_VISIBLE_ANNOTATIONS:
-            return new RuntimeVisibleAnnotations(nameIndex, length, file, constantPool);
+            return new RuntimeVisibleAnnotations(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_RUNTIME_INVISIBLE_ANNOTATIONS:
-            return new RuntimeInvisibleAnnotations(nameIndex, length, file, constantPool);
+            return new RuntimeInvisibleAnnotations(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_RUNTIME_VISIBLE_PARAMETER_ANNOTATIONS:
-            return new RuntimeVisibleParameterAnnotations(nameIndex, length, file, constantPool);
+            return new RuntimeVisibleParameterAnnotations(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_RUNTIME_INVISIBLE_PARAMETER_ANNOTATIONS:
-            return new RuntimeInvisibleParameterAnnotations(nameIndex, length, file, constantPool);
+            return new RuntimeInvisibleParameterAnnotations(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_ANNOTATION_DEFAULT:
-            return new AnnotationDefault(nameIndex, length, file, constantPool);
+            return new AnnotationDefault(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_LOCAL_VARIABLE_TYPE_TABLE:
-            return new LocalVariableTypeTable(nameIndex, length, file, constantPool);
+            return new LocalVariableTypeTable(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_ENCLOSING_METHOD:
-            return new EnclosingMethod(nameIndex, length, file, constantPool);
+            return new EnclosingMethod(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_STACK_MAP_TABLE:
             // read new style stack map: StackMapTable. The rest of the code
             // calls this a StackMap for historical reasons.
-            return new StackMap(nameIndex, length, file, constantPool);
+            return new StackMap(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_BOOTSTRAP_METHODS:
-            return new BootstrapMethods(nameIndex, length, file, constantPool);
+            return new BootstrapMethods(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_METHOD_PARAMETERS:
-            return new MethodParameters(nameIndex, length, file, constantPool);
+            return new MethodParameters(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_MODULE:
-            return new Module(nameIndex, length, file, constantPool);
+            return new Module(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_MODULE_PACKAGES:
-            return new ModulePackages(nameIndex, length, file, constantPool);
+            return new ModulePackages(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_MODULE_MAIN_CLASS:
-            return new ModuleMainClass(nameIndex, length, file, constantPool);
+            return new ModuleMainClass(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_NEST_HOST:
-            return new NestHost(nameIndex, length, file, constantPool);
+            return new NestHost(nameIndex, length, dataInput, constantPool);
         case Const.ATTR_NEST_MEMBERS:
-            return new NestMembers(nameIndex, length, file, constantPool);
+            return new NestMembers(nameIndex, length, dataInput, constantPool);
         default:
             // Never reached
             throw new IllegalStateException("Unrecognized attribute type tag parsed: " + tag);
@@ -196,13 +196,13 @@ public abstract class Attribute implements Cloneable, Node {
      * @see Field
      * @see Method
      *
-     * @param file Input stream
+     * @param dataInputStream Input stream
      * @param constantPool Array of constants
      * @return Attribute
      * @throws IOException if an I/O error occurs.
      */
-    public static Attribute readAttribute(final DataInputStream file, final ConstantPool constantPool) throws IOException {
-        return readAttribute((DataInput) file, constantPool);
+    public static Attribute readAttribute(final DataInputStream dataInputStream, final ConstantPool constantPool) throws IOException {
+        return readAttribute((DataInput) dataInputStream, constantPool);
     }
 
     /**
diff --git a/src/main/java/org/apache/bcel/classfile/StackMap.java b/src/main/java/org/apache/bcel/classfile/StackMap.java
index d4763bbc..ebd8779a 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMap.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMap.java
@@ -42,16 +42,16 @@ public final class StackMap extends Attribute {
      *
      * @param nameIndex Index of name
      * @param length Content length in bytes
-     * @param input Input stream
+     * @param dataInput Input stream
      * @param constantPool Array of constants
      * @throws IOException if an I/O error occurs.
      */
-    StackMap(final int nameIndex, final int length, final DataInput input, final ConstantPool constantPool) throws IOException {
+    StackMap(final int nameIndex, final int length, final DataInput dataInput, final ConstantPool constantPool) throws IOException {
         this(nameIndex, length, (StackMapEntry[]) null, constantPool);
-        final int mapLength = input.readUnsignedShort();
+        final int mapLength = dataInput.readUnsignedShort();
         table = new StackMapEntry[mapLength];
         for (int i = 0; i < mapLength; i++) {
-            table[i] = new StackMapEntry(input, constantPool);
+            table[i] = new StackMapEntry(dataInput, constantPool);
         }
     }
 
diff --git a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
index 58b93ed3..35179075 100644
--- a/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
+++ b/src/main/java/org/apache/bcel/classfile/StackMapEntry.java
@@ -47,44 +47,44 @@ public final class StackMapEntry implements Node, Cloneable {
     /**
      * Construct object from input stream.
      *
-     * @param input Input stream
+     * @param dataInput Input stream
      * @throws IOException if an I/O error occurs.
      */
-    StackMapEntry(final DataInput input, final ConstantPool constantPool) throws IOException {
-        this(input.readByte() & 0xFF, -1, null, null, constantPool);
+    StackMapEntry(final DataInput dataInput, final ConstantPool constantPool) throws IOException {
+        this(dataInput.readByte() & 0xFF, -1, null, null, constantPool);
 
         if (frameType >= Const.SAME_FRAME && frameType <= Const.SAME_FRAME_MAX) {
             byteCodeOffset = frameType - Const.SAME_FRAME;
         } else if (frameType >= Const.SAME_LOCALS_1_STACK_ITEM_FRAME && frameType <= Const.SAME_LOCALS_1_STACK_ITEM_FRAME_MAX) {
             byteCodeOffset = frameType - Const.SAME_LOCALS_1_STACK_ITEM_FRAME;
             typesOfStackItems = new StackMapType[1];
-            typesOfStackItems[0] = new StackMapType(input, constantPool);
+            typesOfStackItems[0] = new StackMapType(dataInput, constantPool);
         } else if (frameType == Const.SAME_LOCALS_1_STACK_ITEM_FRAME_EXTENDED) {
-            byteCodeOffset = input.readShort();
+            byteCodeOffset = dataInput.readShort();
             typesOfStackItems = new StackMapType[1];
-            typesOfStackItems[0] = new StackMapType(input, constantPool);
+            typesOfStackItems[0] = new StackMapType(dataInput, constantPool);
         } else if (frameType >= Const.CHOP_FRAME && frameType <= Const.CHOP_FRAME_MAX) {
-            byteCodeOffset = input.readShort();
+            byteCodeOffset = dataInput.readShort();
         } else if (frameType == Const.SAME_FRAME_EXTENDED) {
-            byteCodeOffset = input.readShort();
+            byteCodeOffset = dataInput.readShort();
         } else if (frameType >= Const.APPEND_FRAME && frameType <= Const.APPEND_FRAME_MAX) {
-            byteCodeOffset = input.readShort();
+            byteCodeOffset = dataInput.readShort();
             final int numberOfLocals = frameType - 251;
             typesOfLocals = new StackMapType[numberOfLocals];
             for (int i = 0; i < numberOfLocals; i++) {
-                typesOfLocals[i] = new StackMapType(input, constantPool);
+                typesOfLocals[i] = new StackMapType(dataInput, constantPool);
             }
         } else if (frameType == Const.FULL_FRAME) {
-            byteCodeOffset = input.readShort();
-            final int numberOfLocals = input.readShort();
+            byteCodeOffset = dataInput.readShort();
+            final int numberOfLocals = dataInput.readShort();
             typesOfLocals = new StackMapType[numberOfLocals];
             for (int i = 0; i < numberOfLocals; i++) {
-                typesOfLocals[i] = new StackMapType(input, constantPool);
+                typesOfLocals[i] = new StackMapType(dataInput, constantPool);
             }
-            final int numberOfStackItems = input.readShort();
+            final int numberOfStackItems = dataInput.readShort();
             typesOfStackItems = new StackMapType[numberOfStackItems];
             for (int i = 0; i < numberOfStackItems; i++) {
-                typesOfStackItems[i] = new StackMapType(input, constantPool);
+                typesOfStackItems[i] = new StackMapType(dataInput, constantPool);
             }
         } else {
             /* Can't happen */