proguard.classfile.util.ClassUtil Maven / Gradle / Ivy
Show all versions of proguard-core Show documentation
/*
* ProGuardCORE -- library to process Java bytecode.
*
* Copyright (c) 2002-2022 Guardsquare NV
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package proguard.classfile.util;
import static proguard.classfile.AccessConstants.FINAL;
import java.util.List;
import proguard.classfile.AccessConstants;
import proguard.classfile.ClassConstants;
import proguard.classfile.Clazz;
import proguard.classfile.JavaAccessConstants;
import proguard.classfile.JavaTypeConstants;
import proguard.classfile.JavaVersionConstants;
import proguard.classfile.TypeConstants;
import proguard.classfile.VersionConstants;
import proguard.evaluation.value.Value;
/**
* Utility methods for:
*
*
* - Converting between internal and external representations of names and descriptions
*
- Operation on {@link Clazz}
*
*/
public class ClassUtil {
private static final String EMPTY_STRING = "";
private ClassUtil() {}
/**
* Checks whether the given class magic number is correct.
*
* @param magicNumber the magic number.
* @throws UnsupportedOperationException when the magic number is incorrect.
*/
public static void checkMagicNumber(int magicNumber) throws UnsupportedOperationException {
if (magicNumber != VersionConstants.MAGIC) {
throw new UnsupportedOperationException(
"Invalid magic number [" + Integer.toHexString(magicNumber) + "] in class");
}
}
/**
* Returns the combined class version number.
*
* @param majorVersion the major part of the class version number.
* @param minorVersion the minor part of the class version number.
* @return the combined class version number.
*/
public static int internalClassVersion(int majorVersion, int minorVersion) {
return (majorVersion << 16) | minorVersion;
}
/**
* Returns the major part of the given class version number.
*
* @param internalClassVersion the combined class version number.
* @return the major part of the class version number.
*/
public static int internalMajorClassVersion(int internalClassVersion) {
return internalClassVersion >>> 16;
}
/**
* Returns the internal class version number.
*
* @param internalClassVersion the external class version number.
* @return the internal class version number.
*/
public static int internalMinorClassVersion(int internalClassVersion) {
return internalClassVersion & 0xffff;
}
/**
* Returns the internal class version number.
*
* @param externalClassVersion the external class version number.
* @return the internal class version number.
*/
public static int internalClassVersion(String externalClassVersion) {
switch (externalClassVersion) {
case JavaVersionConstants.CLASS_VERSION_1_0:
case JavaVersionConstants.CLASS_VERSION_1_1:
return VersionConstants.CLASS_VERSION_1_0;
case JavaVersionConstants.CLASS_VERSION_1_2:
return VersionConstants.CLASS_VERSION_1_2;
case JavaVersionConstants.CLASS_VERSION_1_3:
return VersionConstants.CLASS_VERSION_1_3;
case JavaVersionConstants.CLASS_VERSION_1_4:
return VersionConstants.CLASS_VERSION_1_4;
case JavaVersionConstants.CLASS_VERSION_1_5_ALIAS:
case JavaVersionConstants.CLASS_VERSION_1_5:
return VersionConstants.CLASS_VERSION_1_5;
case JavaVersionConstants.CLASS_VERSION_1_6_ALIAS:
case JavaVersionConstants.CLASS_VERSION_1_6:
return VersionConstants.CLASS_VERSION_1_6;
case JavaVersionConstants.CLASS_VERSION_1_7_ALIAS:
case JavaVersionConstants.CLASS_VERSION_1_7:
return VersionConstants.CLASS_VERSION_1_7;
case JavaVersionConstants.CLASS_VERSION_1_8_ALIAS:
case JavaVersionConstants.CLASS_VERSION_1_8:
return VersionConstants.CLASS_VERSION_1_8;
case JavaVersionConstants.CLASS_VERSION_1_9_ALIAS:
case JavaVersionConstants.CLASS_VERSION_1_9:
return VersionConstants.CLASS_VERSION_1_9;
case JavaVersionConstants.CLASS_VERSION_10:
return VersionConstants.CLASS_VERSION_10;
case JavaVersionConstants.CLASS_VERSION_11:
return VersionConstants.CLASS_VERSION_11;
case JavaVersionConstants.CLASS_VERSION_12:
return VersionConstants.CLASS_VERSION_12;
case JavaVersionConstants.CLASS_VERSION_13:
return VersionConstants.CLASS_VERSION_13;
case JavaVersionConstants.CLASS_VERSION_14:
return VersionConstants.CLASS_VERSION_14;
case JavaVersionConstants.CLASS_VERSION_15:
return VersionConstants.CLASS_VERSION_15;
case JavaVersionConstants.CLASS_VERSION_16:
return VersionConstants.CLASS_VERSION_16;
case JavaVersionConstants.CLASS_VERSION_17:
return VersionConstants.CLASS_VERSION_17;
case JavaVersionConstants.CLASS_VERSION_18:
return VersionConstants.CLASS_VERSION_18;
case JavaVersionConstants.CLASS_VERSION_19:
return VersionConstants.CLASS_VERSION_19;
case JavaVersionConstants.CLASS_VERSION_20:
return VersionConstants.CLASS_VERSION_20;
case JavaVersionConstants.CLASS_VERSION_21:
return VersionConstants.CLASS_VERSION_21;
case JavaVersionConstants.CLASS_VERSION_22:
return VersionConstants.CLASS_VERSION_22;
case JavaVersionConstants.CLASS_VERSION_23:
return VersionConstants.CLASS_VERSION_23;
}
return 0;
}
/**
* Returns the minor part of the given class version number.
*
* @param internalClassVersion the combined class version number.
* @return the minor part of the class version number.
*/
public static String externalClassVersion(int internalClassVersion) {
switch (internalClassVersion) {
case VersionConstants.CLASS_VERSION_1_0:
return JavaVersionConstants.CLASS_VERSION_1_0;
case VersionConstants.CLASS_VERSION_1_2:
return JavaVersionConstants.CLASS_VERSION_1_2;
case VersionConstants.CLASS_VERSION_1_3:
return JavaVersionConstants.CLASS_VERSION_1_3;
case VersionConstants.CLASS_VERSION_1_4:
return JavaVersionConstants.CLASS_VERSION_1_4;
case VersionConstants.CLASS_VERSION_1_5:
return JavaVersionConstants.CLASS_VERSION_1_5;
case VersionConstants.CLASS_VERSION_1_6:
return JavaVersionConstants.CLASS_VERSION_1_6;
case VersionConstants.CLASS_VERSION_1_7:
return JavaVersionConstants.CLASS_VERSION_1_7;
case VersionConstants.CLASS_VERSION_1_8:
return JavaVersionConstants.CLASS_VERSION_1_8;
case VersionConstants.CLASS_VERSION_1_9:
return JavaVersionConstants.CLASS_VERSION_1_9;
case VersionConstants.CLASS_VERSION_10:
return JavaVersionConstants.CLASS_VERSION_10;
case VersionConstants.CLASS_VERSION_11:
return JavaVersionConstants.CLASS_VERSION_11;
case VersionConstants.CLASS_VERSION_12:
return JavaVersionConstants.CLASS_VERSION_12;
case VersionConstants.CLASS_VERSION_13:
return JavaVersionConstants.CLASS_VERSION_13;
case VersionConstants.CLASS_VERSION_14:
return JavaVersionConstants.CLASS_VERSION_14;
case VersionConstants.CLASS_VERSION_15:
return JavaVersionConstants.CLASS_VERSION_15;
case VersionConstants.CLASS_VERSION_16:
return JavaVersionConstants.CLASS_VERSION_16;
case VersionConstants.CLASS_VERSION_17:
return JavaVersionConstants.CLASS_VERSION_17;
case VersionConstants.CLASS_VERSION_18:
return JavaVersionConstants.CLASS_VERSION_18;
case VersionConstants.CLASS_VERSION_19:
return JavaVersionConstants.CLASS_VERSION_19;
case VersionConstants.CLASS_VERSION_20:
return JavaVersionConstants.CLASS_VERSION_20;
case VersionConstants.CLASS_VERSION_21:
return JavaVersionConstants.CLASS_VERSION_21;
case VersionConstants.CLASS_VERSION_22:
return JavaVersionConstants.CLASS_VERSION_22;
case VersionConstants.CLASS_VERSION_23:
return JavaVersionConstants.CLASS_VERSION_23;
default:
return null;
}
}
/**
* Checks whether the given class version number is supported.
*
* @param internalClassVersion the combined class version number.
* @throws UnsupportedOperationException when the version is not supported.
*/
public static void checkVersionNumbers(int internalClassVersion)
throws UnsupportedOperationException {
if (internalClassVersion < VersionConstants.CLASS_VERSION_1_0
|| internalClassVersion > VersionConstants.MAX_SUPPORTED_VERSION) {
throw new UnsupportedOperationException(
"Unsupported version number ["
+ internalMajorClassVersion(internalClassVersion)
+ "."
+ internalMinorClassVersion(internalClassVersion)
+ "] (maximum "
+ internalMajorClassVersion(VersionConstants.MAX_SUPPORTED_VERSION)
+ "."
+ internalMinorClassVersion(VersionConstants.MAX_SUPPORTED_VERSION)
+ ", Java "
+ externalClassVersion(VersionConstants.MAX_SUPPORTED_VERSION)
+ ")");
}
}
/**
* Converts an external class name into an internal class name.
*
* @param externalClassName the external class name, e.g. "java.lang.Object"
* @return the internal class name, e.g. "java/lang/Object".
*/
public static String internalClassName(String externalClassName) {
return externalClassName.replace(
JavaTypeConstants.PACKAGE_SEPARATOR, TypeConstants.PACKAGE_SEPARATOR);
}
/**
* Converts an external class name into a canonical class name.
*
* @param externalClassName the external class name e.g. com.example.Enclosing$Inner
* @return the canonical class name, e.g. com.example.Enclosing.Inner
*/
public static String canonicalClassName(String externalClassName) {
return externalClassName.replace(
JavaTypeConstants.SPECIAL_MEMBER_SEPARATOR, JavaTypeConstants.PACKAGE_SEPARATOR);
}
/**
* Converts an internal class description into an external class description.
*
* @param accessFlags the access flags of the class.
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return the external class description, e.g. "public java.lang.Object".
*/
public static String externalFullClassDescription(int accessFlags, String internalClassName) {
return externalClassAccessFlags(accessFlags) + externalClassName(internalClassName);
}
/**
* Converts an internal class name into an external class name.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return the external class name, e.g. "java.lang.Object".
*/
public static String externalClassName(String internalClassName) {
return // internalClassName.startsWith(ClassConstants.PACKAGE_JAVA_LANG) &&
// internalClassName.indexOf(TypeConstants.PACKAGE_SEPARATOR,
// ClassConstants.PACKAGE_JAVA_LANG.length() + 1) < 0 ?
// internalClassName.substring(ClassConstants.PACKAGE_JAVA_LANG.length()) :
internalClassName.replace(TypeConstants.PACKAGE_SEPARATOR, JavaTypeConstants.PACKAGE_SEPARATOR);
}
/**
* Returns the external base type of an external array type, dropping any array brackets.
*
* @param externalArrayType the external array type, e.g. "java.lang.Object[][]"
* @return the external base type, e.g. "java.lang.Object".
*/
public static String externalBaseType(String externalArrayType) {
int index = externalArrayType.indexOf(JavaTypeConstants.ARRAY);
return index >= 0 ? externalArrayType.substring(0, index) : externalArrayType;
}
/**
* Returns the external short class name of an external class name, dropping the package
* specification.
*
* @param externalClassName the external class name, e.g. "java.lang.Object"
* @return the external short class name, e.g. "Object".
*/
public static String externalShortClassName(String externalClassName) {
int index = externalClassName.lastIndexOf(JavaTypeConstants.PACKAGE_SEPARATOR);
return externalClassName.substring(index + 1);
}
/**
* Returns the internal short class name of an internal class name, dropping the package
* specification.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object"
* @return the internal short class name, e.g. "Object".
*/
public static String internalShortClassName(String internalClassName) {
int index = internalClassName.lastIndexOf(TypeConstants.PACKAGE_SEPARATOR);
return internalClassName.substring(index + 1);
}
/**
* Returns whether the given internal type is an array type.
*
* @param internalType the internal type, e.g. "[[Ljava/lang/Object;".
* @return true if the given type is an array type, false otherwise.
*/
public static boolean isInternalArrayType(String internalType) {
return internalType.length() > 1 && internalType.charAt(0) == TypeConstants.ARRAY;
}
/**
* Returns the number of dimensions of the given internal type.
*
* @param internalType the internal type, e.g. "[[Ljava/lang/Object;".
* @return the number of dimensions, e.g. 2.
*/
public static int internalArrayTypeDimensionCount(String internalType) {
int dimensions = 0;
while (dimensions < internalType.length()
&& internalType.charAt(dimensions) == TypeConstants.ARRAY) {
dimensions++;
}
return dimensions;
}
/**
* Returns whether the given internal class name is one of the interfaces that is implemented by
* all array types. These class names are "java/lang/Object", "
* java/lang/Cloneable", and "java/io/Serializable"
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return true if the given type is an array interface name, false
* otherwise.
*/
public static boolean isInternalArrayInterfaceName(String internalClassName) {
return ClassConstants.NAME_JAVA_LANG_OBJECT.equals(internalClassName)
|| ClassConstants.NAME_JAVA_LANG_CLONEABLE.equals(internalClassName)
|| ClassConstants.NAME_JAVA_IO_SERIALIZABLE.equals(internalClassName);
}
/**
* Returns whether the given internal type is a plain primitive type (not void).
*
* @param internalType the internal type, e.g. "I".
* @return true if the given type is a class type, false otherwise.
*/
public static boolean isInternalPrimitiveType(char internalType) {
return internalType == TypeConstants.BOOLEAN
|| internalType == TypeConstants.BYTE
|| internalType == TypeConstants.CHAR
|| internalType == TypeConstants.SHORT
|| internalType == TypeConstants.INT
|| internalType == TypeConstants.FLOAT
|| internalType == TypeConstants.LONG
|| internalType == TypeConstants.DOUBLE;
}
/**
* Returns whether the given internal type is a plain primitive type (not void).
*
* @param internalType the internal type, e.g. "I".
* @return true if the given type is an internal primitive type, false
* otherwise.
*/
public static boolean isInternalPrimitiveType(String internalType) {
return isInternalPrimitiveType(internalType.charAt(0));
}
/**
* Returns whether the given class is a class boxing a primitive type (not void).
*
* @param internalType the internal type, e.g. "Ljava/lang/Integer;".
* @return true if the given type is a boxing internal type of a class boxing a
* primitive, false otherwise.
*/
public static boolean isInternalPrimitiveBoxingType(String internalType) {
return ClassConstants.TYPE_JAVA_LANG_BOOLEAN.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_BYTE.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_CHARACTER.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_SHORT.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_INTEGER.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_FLOAT.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_LONG.equals(internalType)
|| ClassConstants.TYPE_JAVA_LANG_DOUBLE.equals(internalType);
}
/**
* Returns the primitive type corresponding to the given internal primitive boxing type.
*
* @param type an internal primitive boxing type, e.g. "Ljava/lang/Integer;".
* @return the corresponding primitive type, e.g. "I".
*/
public static char internalPrimitiveTypeFromPrimitiveBoxingType(String type) {
if (!isInternalPrimitiveBoxingType(type)) {
throw new IllegalArgumentException("The argument is not a primitive boxing internal type");
}
return internalPrimitiveTypeFromNumericClassName(internalClassNameFromType(type));
}
/**
* Returns whether the given internal type is a plain primitive type (not void) or a
* java/lang/String.
*
* @param internalType the internal type, e.g. "I".
* @return true if the given type is a class type, false otherwise.
*/
public static boolean isInternalPrimitiveTypeOrString(String internalType) {
return internalType.equals(ClassConstants.TYPE_JAVA_LANG_STRING)
|| isInternalPrimitiveType(internalType.charAt(0));
}
/**
* Returns whether the given internal type is a primitive Category 2 type.
*
* @param internalType the internal type, e.g. "L".
* @return true if the given type is a Category 2 type, false otherwise.
*/
public static boolean isInternalCategory2Type(String internalType) {
return internalType.length() == 1
&& (internalType.charAt(0) == TypeConstants.LONG
|| internalType.charAt(0) == TypeConstants.DOUBLE);
}
/**
* Returns whether the given internal type is a plain class type (including an array type of a
* plain class type).
*
* @param internalType the internal type, e.g. "Ljava/lang/Object;".
* @return true if the given type is a class type, false otherwise.
*/
public static boolean isInternalClassType(String internalType) {
int length = internalType.length();
return length > 1
&&
// internalType.charAt(0) == TypeConstants.CLASS_START &&
internalType.charAt(length - 1) == TypeConstants.CLASS_END;
}
/**
* Returns whether the given type is an internal type, i.e. one of:
*
* - an internal array type; - an internal primitive type; - an internal class type.
*
* @param type the type, e.g. "Ljava/lang/String;", "I"
* @return true if the given type is a class type, false otherwise.
*/
public static boolean isInternalType(String type) {
return isInternalArrayType(type) || isInternalPrimitiveType(type) || isInternalClassType(type);
}
/**
* Returns the internal type of a given class name.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return the internal type, e.g. "Ljava/lang/Object;".
*/
public static String internalTypeFromClassName(String internalClassName) {
return internalArrayTypeFromClassName(internalClassName, 0);
}
/**
* Returns the internal array type of a given class name with a given number of dimensions. If the
* number of dimensions is 0, the class name itself is returned.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @param dimensionCount the number of array dimensions.
* @return the internal array type of the array elements, e.g. "Ljava/lang/Object;".
*/
public static String internalArrayTypeFromClassName(
String internalClassName, int dimensionCount) {
StringBuilder buffer = new StringBuilder(internalClassName.length() + dimensionCount + 2);
for (int dimension = 0; dimension < dimensionCount; dimension++) {
buffer.append(TypeConstants.ARRAY);
}
return buffer
.append(TypeConstants.CLASS_START)
.append(internalClassName)
.append(TypeConstants.CLASS_END)
.toString();
}
/**
* Returns the internal array type of a given type, with a given number of additional dimensions.
*
* @param internalType the internal class name, e.g. "[Ljava/lang/Object;".
* @param dimensionDelta the number of additional array dimensions, e.g. 1.
* @return the internal array type of the array elements, e.g. "[[Ljava/lang/Object;
* ".
*/
public static String internalArrayTypeFromType(String internalType, int dimensionDelta) {
StringBuilder buffer = new StringBuilder(internalType.length() + dimensionDelta);
for (int dimension = 0; dimension < dimensionDelta; dimension++) {
buffer.append(TypeConstants.ARRAY);
}
return buffer.append(internalType).toString();
}
/**
* Returns the internal element type of a given internal array type.
*
* @param internalArrayType the internal array type, e.g. "[[Ljava/lang/Object;" or "
* [I".
* @return the internal type of the array elements, e.g. "Ljava/lang/Object;" or "
* I".
*/
public static String internalTypeFromArrayType(String internalArrayType) {
int index = internalArrayType.lastIndexOf(TypeConstants.ARRAY);
return internalArrayType.substring(index + 1);
}
/**
* Returns the internal class type (class name or array type) of a given internal type (including
* an array type). This is the type that can be stored in a class constant.
*
* @param internalType the internal class type, e.g. "[I", "[Ljava/lang/Object;
* ", or "Ljava/lang/Object;".
* @return the internal class name, e.g. "[I", "[Ljava/lang/Object;", or
* "java/lang/Object".
*/
public static String internalClassTypeFromType(String internalType) {
return isInternalArrayType(internalType)
? internalType
: internalClassNameFromClassType(internalType);
}
/**
* Returns the internal type of a given class type (class name or array type). This is the type
* that can be stored in a class constant.
*
* @param internalType the internal class type, e.g. "[I", "[Ljava/lang/Object;
* ", or "java/lang/Object".
* @return the internal class name, e.g. "[I", "[Ljava/lang/Object;", or
* "Ljava/lang/Object;".
*/
public static String internalTypeFromClassType(String internalType) {
return isInternalArrayType(internalType)
? internalType
: internalTypeFromClassName(internalType);
}
/**
* Returns the internal class name of a given internal class type (including an array type). Types
* involving primitive types are returned unchanged. Note: If you are parsing a Signature
* attribute string, use {@link ClassUtil#internalClassNameFromClassSignature(String)} instead, as
* this method will not handle generic type parameters and the '.' as inner class separator.
*
* @param internalClassType the internal class type, e.g. "[Ljava/lang/Object;", "
* Ljava/lang/Object;", or "java/lang/Object".
* @return the internal class name, e.g. "java/lang/Object".
*/
public static String internalClassNameFromClassType(String internalClassType) {
return isInternalClassType(internalClassType)
? internalClassType.substring(
internalClassType.indexOf(TypeConstants.CLASS_START) + 1,
internalClassType.length() - 1)
: internalClassType;
}
/**
* Returns the internal class name for a given Class Signature.
*
* @param classSignature the class signature, e.g. "Lsome/package/Klass< T;>.Inner"
* @return the internal class name, e.g. "some/package/Klass$Inner".
*/
public static String internalClassNameFromClassSignature(String classSignature) {
// Remove generic type information.
String internalClassName = removeGenericTypes(classSignature);
// Remove the 'L' and ';' bits.
internalClassName = internalClassNameFromClassType(internalClassName);
// Convert each '.' to a '$', as dictated by the JVM spec.
// See: https://docs.oracle.com/javase/specs/jvms/se7/html/jvms-4.html#jvms-4.3.4
return internalClassName.replace('.', '$');
}
/** Remove any generic type parameters from the given descriptor. */
public static String removeGenericTypes(String descriptor) {
int start = descriptor.indexOf('<');
int end = descriptor.lastIndexOf('>');
if (start < end && start >= 0) {
int index = start;
while (index < end) {
index++;
if (descriptor.charAt(index) == '<') {
start = index;
} else if (descriptor.charAt(index) == '>') {
// Found a closing tag, by this point it has to be the most inner one.
return removeGenericTypes(
descriptor.substring(0, start) + descriptor.substring(index + 1));
}
}
}
return descriptor;
}
/**
* Returns the internal class name of any given internal descriptor type, disregarding array
* prefixes.
*
* @param internalClassType the internal class type, e.g. "Ljava/lang/Object;" or "
* [[I".
* @return the internal class name, e.g. "java/lang/Object" or null.
*/
public static String internalClassNameFromType(String internalClassType) {
if (!isInternalClassType(internalClassType)) {
return null;
}
// Is it an array type?
if (isInternalArrayType(internalClassType)) {
internalClassType = internalTypeFromArrayType(internalClassType);
}
return internalClassNameFromClassType(internalClassType);
}
/**
* Returns the internal numeric (or void or array) class name corresponding to the given internal
* primitive type.
*
* @param internalPrimitiveType the internal class type, e.g. "I" or "V
* ".
* @return the internal class name, e.g. "java/lang/Integer" or java/lang/Void
* .
*/
public static String internalNumericClassNameFromPrimitiveType(char internalPrimitiveType) {
switch (internalPrimitiveType) {
case TypeConstants.VOID:
return ClassConstants.NAME_JAVA_LANG_VOID;
case TypeConstants.BOOLEAN:
return ClassConstants.NAME_JAVA_LANG_BOOLEAN;
case TypeConstants.BYTE:
return ClassConstants.NAME_JAVA_LANG_BYTE;
case TypeConstants.CHAR:
return ClassConstants.NAME_JAVA_LANG_CHARACTER;
case TypeConstants.SHORT:
return ClassConstants.NAME_JAVA_LANG_SHORT;
case TypeConstants.INT:
return ClassConstants.NAME_JAVA_LANG_INTEGER;
case TypeConstants.LONG:
return ClassConstants.NAME_JAVA_LANG_LONG;
case TypeConstants.FLOAT:
return ClassConstants.NAME_JAVA_LANG_FLOAT;
case TypeConstants.DOUBLE:
return ClassConstants.NAME_JAVA_LANG_DOUBLE;
case TypeConstants.ARRAY:
return ClassConstants.NAME_JAVA_LANG_REFLECT_ARRAY;
default:
throw new IllegalArgumentException(
"Unexpected primitive type [" + internalPrimitiveType + "]");
}
}
/**
* Returns the internal numeric (or void or array) class name corresponding to the given internal
* primitive type.
*
* @param internalPrimitiveClassName the internal class name, e.g. "java/lang/Integer
* " or java/lang/Void.
* @return the internal class type, e.g. "I" or "V".
*/
public static char internalPrimitiveTypeFromNumericClassName(String internalPrimitiveClassName) {
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_VOID))
return TypeConstants.VOID;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_BOOLEAN))
return TypeConstants.BOOLEAN;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_BYTE))
return TypeConstants.BYTE;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_CHARACTER))
return TypeConstants.CHAR;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_SHORT))
return TypeConstants.SHORT;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_INTEGER))
return TypeConstants.INT;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_LONG))
return TypeConstants.LONG;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_FLOAT))
return TypeConstants.FLOAT;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_DOUBLE))
return TypeConstants.DOUBLE;
if (internalPrimitiveClassName.equals(ClassConstants.NAME_JAVA_LANG_REFLECT_ARRAY))
return TypeConstants.ARRAY;
throw new IllegalArgumentException(
"Unexpected primitive class name [" + internalPrimitiveClassName + "]");
}
/**
* Returns the simple name of an internal class name, dropping the package specification and any
* outer class part.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object"
* @return the simple class name, e.g. "Object".
*/
public static String internalSimpleClassName(String internalClassName) {
int index1 = internalClassName.lastIndexOf(TypeConstants.PACKAGE_SEPARATOR);
int index2 = internalClassName.lastIndexOf(TypeConstants.INNER_CLASS_SEPARATOR);
return internalClassName.substring(Math.max(index1, index2) + 1);
}
/**
* The internal primitive type computational type.
*
* @param internalPrimitiveType an internal primitive type (e.g., "Z")
* @return the int representing the type internally (from the constants in {@link Value}).
*/
public static int internalPrimitiveTypeToComputationalType(String internalPrimitiveType) {
switch (internalPrimitiveType) {
case "I":
case "Z":
return Value.TYPE_INTEGER;
case "J":
return Value.TYPE_LONG;
case "D":
return Value.TYPE_DOUBLE;
case "F":
return Value.TYPE_FLOAT;
default:
return Value.TYPE_UNKNOWN;
}
}
/**
* Returns whether the given method name refers to a class initializer or an instance initializer.
*
* @param internalMethodName The internal method name, e.g. "<clinit>".
* @return Whether the method name refers to an initializer, e.g. true.
*/
public static boolean isInitializer(String internalMethodName) {
return isClassInitializer(internalMethodName) || isInstanceInitializer(internalMethodName);
}
/**
* Returns whether the given method name refers to a class initializer.
*
* @param internalMethodName The internal method name, e.g. "<clinit>".
* @return Whether the method name refers to a class initializer, e.g. true.
*/
public static boolean isClassInitializer(String internalMethodName) {
return ClassConstants.METHOD_NAME_CLINIT.equals(internalMethodName);
}
/**
* Returns whether the given method name refers to an instance initializer.
*
* @param internalMethodName The internal method name, e.g. "<init>".
* @return Whether the method name refers to an instance initializer, e.g. true.
*/
public static boolean isInstanceInitializer(String internalMethodName) {
return ClassConstants.METHOD_NAME_INIT.equals(internalMethodName);
}
/**
* Returns the internal type of the given internal method descriptor.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(II)Z".
* @return the internal return type, e.g. "Z".
*/
public static String internalMethodReturnType(String internalMethodDescriptor) {
int index = internalMethodDescriptor.indexOf(TypeConstants.METHOD_ARGUMENTS_CLOSE);
return internalMethodDescriptor.substring(index + 1);
}
/**
* Returns the number of parameters of the given internal method descriptor.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @return the number of parameters, e.g. 2.
*/
public static int internalMethodParameterCount(String internalMethodDescriptor) {
return internalMethodParameterCount(internalMethodDescriptor, true);
}
/**
* Returns the number of parameters of the given internal method descriptor.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @param accessFlags the access flags of the method, e.g. 0.
* @return the number of parameters, e.g. 3.
*/
public static int internalMethodParameterCount(String internalMethodDescriptor, int accessFlags) {
return internalMethodParameterCount(
internalMethodDescriptor, (accessFlags & AccessConstants.STATIC) != 0);
}
/**
* Returns the number of parameters of the given internal method descriptor.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @param isStatic specifies whether the method is static, e.g. false.
* @return the number of parameters, e.g. 3.
*/
public static int internalMethodParameterCount(
String internalMethodDescriptor, boolean isStatic) {
int counter = isStatic ? 0 : 1;
int index = 1;
while (true) {
char c = internalMethodDescriptor.charAt(index++);
switch (c) {
case TypeConstants.ARRAY:
{
// Just ignore all array characters.
break;
}
case TypeConstants.CLASS_START:
{
counter++;
// Skip the class name.
index = internalMethodDescriptor.indexOf(TypeConstants.CLASS_END, index) + 1;
if (index == 0) {
throw new IllegalStateException(
"No matching semicolon found for class start character");
}
break;
}
default:
{
counter++;
break;
}
case TypeConstants.METHOD_ARGUMENTS_CLOSE:
{
return counter;
}
}
}
}
/**
* Returns the size taken up on the stack by the parameters of the given internal method
* descriptor. This accounts for long and double parameters taking up two entries.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @return the size taken up on the stack, e.g. 3.
*/
public static int internalMethodParameterSize(String internalMethodDescriptor) {
return internalMethodParameterSize(internalMethodDescriptor, true);
}
/**
* Returns the size taken up on the stack by the parameters of the given internal method
* descriptor. This accounts for long and double parameters taking up two entries, and a
* non-static method taking up an additional entry.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @param accessFlags the access flags of the method, e.g. 0.
* @return the size taken up on the stack, e.g. 4.
*/
public static int internalMethodParameterSize(String internalMethodDescriptor, int accessFlags) {
return internalMethodParameterSize(
internalMethodDescriptor, (accessFlags & AccessConstants.STATIC) != 0);
}
/**
* Returns the size taken up on the stack by the parameters of the given internal method
* descriptor. This accounts for long and double parameters taking up two spaces, and a non-static
* method taking up an additional entry.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(ID)Z".
* @param isStatic specifies whether the method is static, e.g. false.
* @return the size taken up on the stack, e.g. 4.
*/
public static int internalMethodParameterSize(String internalMethodDescriptor, boolean isStatic) {
int size = isStatic ? 0 : 1;
int index = 1;
while (true) {
char c = internalMethodDescriptor.charAt(index++);
switch (c) {
case TypeConstants.LONG:
case TypeConstants.DOUBLE:
{
size += 2;
break;
}
case TypeConstants.CLASS_START:
{
size++;
// Skip the class name.
index = internalMethodDescriptor.indexOf(TypeConstants.CLASS_END, index) + 1;
break;
}
case TypeConstants.ARRAY:
{
size++;
// Skip all array characters.
while ((c = internalMethodDescriptor.charAt(index++)) == TypeConstants.ARRAY) {}
if (c == TypeConstants.CLASS_START) {
// Skip the class type.
index = internalMethodDescriptor.indexOf(TypeConstants.CLASS_END, index) + 1;
}
break;
}
default:
{
size++;
break;
}
case TypeConstants.METHOD_ARGUMENTS_CLOSE:
{
return size;
}
}
}
}
/**
* Returns the parameter number in the given internal method descriptor, corresponding to the
* given variable index. This accounts for long and double parameters taking up two spaces, and a
* non-static method taking up an additional entry. The method returns 0 if the index corresponds
* to the 'this' parameter and -1 if the index does not correspond to a parameter.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(IDI)Z".
* @param accessFlags the access flags of the method, e.g. 0.
* @param variableIndex the variable index of the parameter, e.g. 4.
* @return the parameter number in the descriptor, e.g. 3.
*/
public static int internalMethodParameterNumber(
String internalMethodDescriptor, int accessFlags, int variableIndex) {
return internalMethodParameterNumber(
internalMethodDescriptor, (accessFlags & AccessConstants.STATIC) != 0, variableIndex);
}
/**
* Returns the parameter number in the given internal method descriptor, corresponding to the
* given variable index. This accounts for long and double parameters taking up two spaces, and a
* non-static method taking up an additional entry. The method returns 0 if the index corresponds
* to the 'this' parameter and -1 if the index does not correspond to a parameter.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(IDI)Z".
* @param isStatic specifies whether the method is static, e.g. false.
* @param variableIndex the variable index of the parameter, e.g. 4.
* @return the parameter number in the descriptor, e.g. 3.
*/
public static int internalMethodParameterNumber(
String internalMethodDescriptor, boolean isStatic, int variableIndex) {
int parameterIndex = 0;
int parameterNumber = 0;
// Is it a non-static method?
if (!isStatic) {
if (variableIndex == 0) {
return 0;
}
variableIndex--;
parameterNumber++;
}
// Loop over all variables until we've found the right index.
InternalTypeEnumeration internalTypeEnumeration =
new InternalTypeEnumeration(internalMethodDescriptor);
while (internalTypeEnumeration.hasMoreTypes()) {
if (variableIndex == parameterIndex) {
return parameterNumber;
}
String internalType = internalTypeEnumeration.nextType();
parameterIndex += internalTypeSize(internalType);
parameterNumber++;
}
return -1;
}
/**
* Returns the variable index corresponding to the given parameter number in the given internal
* method descriptor. This accounts for long and double parameters taking up two spaces, and a
* non-static method taking up an additional entry. The method returns 0 if the number corresponds
* to the 'this' parameter and -1 if the number does not correspond to a parameter.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(IDI)Z".
* @param accessFlags the access flags of the method, e.g. 0.
* @param parameterNumber the parameter number, e.g. 3.
* @return the corresponding variable index, e.g. 4.
*/
public static int internalMethodVariableIndex(
String internalMethodDescriptor, int accessFlags, int parameterNumber) {
return internalMethodVariableIndex(
internalMethodDescriptor, (accessFlags & AccessConstants.STATIC) != 0, parameterNumber);
}
/**
* Returns the parameter index in the given internal method descriptor, corresponding to the given
* variable number. This accounts for long and double parameters taking up two spaces, and a
* non-static method taking up an additional entry. The method returns 0 if the number corresponds
* to the 'this' parameter and -1 if the number does not correspond to a parameter.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(IDI)Z".
* @param isStatic specifies whether the method is static, e.g. false.
* @param parameterNumber the parameter number, e.g. 3.
* @return the corresponding variable index, e.g. 4.
*/
public static int internalMethodVariableIndex(
String internalMethodDescriptor, boolean isStatic, int parameterNumber) {
int variableNumber = 0;
int variableIndex = isStatic ? 0 : 1;
// Loop over the given number of parameters.
InternalTypeEnumeration internalTypeEnumeration =
new InternalTypeEnumeration(internalMethodDescriptor);
for (int counter = 0; counter < parameterNumber; counter++) {
String internalType = internalTypeEnumeration.nextType();
variableIndex += internalTypeSize(internalType);
}
return variableIndex;
}
/**
* Returns the internal type of the parameter in the given method descriptor, at the given index.
*
* @param internalMethodDescriptor the internal method descriptor e.g. "(IDI)Z".
* @param parameterIndex the parameter index, e.g. 1.
* @return the parameter's type, e.g. "D".
*/
public static String internalMethodParameterType(
String internalMethodDescriptor, int parameterIndex) {
InternalTypeEnumeration typeEnum = new InternalTypeEnumeration(internalMethodDescriptor);
String type = null;
for (int i = 0; i <= parameterIndex; i++) {
type = typeEnum.nextType();
}
return type;
}
/**
* Returns the size taken up on the stack by the given internal type. The size is 1, except for
* long and double types, for which it is 2, and for the void type, for which 0 is returned.
*
* @param internalType the internal type, e.g. "I".
* @return the size taken up on the stack, e.g. 1.
*/
public static int internalTypeSize(String internalType) {
if (internalType.length() == 1) {
char internalPrimitiveType = internalType.charAt(0);
if (internalPrimitiveType == TypeConstants.LONG
|| internalPrimitiveType == TypeConstants.DOUBLE) {
return 2;
} else if (internalPrimitiveType == TypeConstants.VOID) {
return 0;
}
}
return 1;
}
/**
* Converts an external type into an internal type.
*
* @param externalType the external type, e.g. "java.lang.Object[][]" or "int[]
* ".
* @return the internal type, e.g. "[[Ljava/lang/Object;" or "[I".
*/
public static String internalType(String externalType) {
// Strip the array part, if any.
int dimensionCount = externalArrayTypeDimensionCount(externalType);
if (dimensionCount > 0) {
externalType =
externalType.substring(
0, externalType.length() - dimensionCount * JavaTypeConstants.ARRAY.length());
}
// Analyze the actual type part.
char internalTypeChar =
externalType.equals(JavaTypeConstants.VOID)
? TypeConstants.VOID
: externalType.equals(JavaTypeConstants.BOOLEAN)
? TypeConstants.BOOLEAN
: externalType.equals(JavaTypeConstants.BYTE)
? TypeConstants.BYTE
: externalType.equals(JavaTypeConstants.CHAR)
? TypeConstants.CHAR
: externalType.equals(JavaTypeConstants.SHORT)
? TypeConstants.SHORT
: externalType.equals(JavaTypeConstants.INT)
? TypeConstants.INT
: externalType.equals(JavaTypeConstants.FLOAT)
? TypeConstants.FLOAT
: externalType.equals(JavaTypeConstants.LONG)
? TypeConstants.LONG
: externalType.equals(JavaTypeConstants.DOUBLE)
? TypeConstants.DOUBLE
: externalType.equals("%") ? '%' : (char) 0;
String internalType =
internalTypeChar != 0
? String.valueOf(internalTypeChar)
: TypeConstants.CLASS_START + internalClassName(externalType) + TypeConstants.CLASS_END;
// Prepend the array part, if any.
for (int count = 0; count < dimensionCount; count++) {
internalType = TypeConstants.ARRAY + internalType;
}
return internalType;
}
/**
* Returns the number of dimensions of the given external type.
*
* @param externalType the external type, e.g. "[[Ljava/lang/Object;".
* @return the number of dimensions, e.g. 2.
*/
public static int externalArrayTypeDimensionCount(String externalType) {
int dimensions = 0;
int length = JavaTypeConstants.ARRAY.length();
int offset = externalType.length() - length;
while (externalType.regionMatches(offset, JavaTypeConstants.ARRAY, 0, length)) {
dimensions++;
offset -= length;
}
return dimensions;
}
/**
* Converts an internal type into an external type.
*
* @param internalType the internal type, e.g. "Ljava/lang/Object;" or "
* [[Ljava/lang/Object;" or "[I".
* @return the external type, e.g. "java.lang.Object" or "java.lang.Object[][]
* " or "int[]".
* @throws IllegalArgumentException if the type is invalid.
*/
public static String externalType(String internalType) {
if (internalType == null) {
throw new IllegalArgumentException("Invalid type, null string");
} else if (internalType.length() == 0) {
throw new IllegalArgumentException("Invalid type, empty string");
}
// Strip the array part, if any.
int dimensionCount = internalArrayTypeDimensionCount(internalType);
if (dimensionCount > 0) {
if (internalType.length() <= dimensionCount) {
throw new IllegalArgumentException("Invalid array type [" + internalType + "]");
}
internalType = internalType.substring(dimensionCount);
}
// Analyze the actual type part.
char internalTypeChar = internalType.charAt(0);
if ((isInternalPrimitiveType(internalTypeChar)
|| internalTypeChar == TypeConstants.VOID
|| internalTypeChar == '%')
&& internalType.length() > 1) {
throw new IllegalArgumentException("Invalid primitive type [" + internalType + "]");
} else if (internalTypeChar == TypeConstants.CLASS_START
&& internalType.indexOf(TypeConstants.CLASS_END) == -1) {
throw new IllegalArgumentException(
"Invalid class type, missing \";\" [" + internalType + "]");
} else if (internalTypeChar == TypeConstants.VOID && dimensionCount > 0) {
throw new IllegalArgumentException("Invalid array type [" + internalType + "]");
}
String externalType =
internalTypeChar == TypeConstants.VOID
? JavaTypeConstants.VOID
: internalTypeChar == TypeConstants.BOOLEAN
? JavaTypeConstants.BOOLEAN
: internalTypeChar == TypeConstants.BYTE
? JavaTypeConstants.BYTE
: internalTypeChar == TypeConstants.CHAR
? JavaTypeConstants.CHAR
: internalTypeChar == TypeConstants.SHORT
? JavaTypeConstants.SHORT
: internalTypeChar == TypeConstants.INT
? JavaTypeConstants.INT
: internalTypeChar == TypeConstants.FLOAT
? JavaTypeConstants.FLOAT
: internalTypeChar == TypeConstants.LONG
? JavaTypeConstants.LONG
: internalTypeChar == TypeConstants.DOUBLE
? JavaTypeConstants.DOUBLE
: internalTypeChar == '%'
? "%"
: internalTypeChar == TypeConstants.CLASS_START
? externalClassName(
internalType.substring(
1,
internalType.indexOf(
TypeConstants.CLASS_END)))
: null;
if (externalType == null || externalType.length() == 0) {
throw new IllegalArgumentException("Unknown type [" + internalType + "]");
}
// Append the array part, if any. This won't happen very often, so
// we're not using a builder.
for (int count = 0; count < dimensionCount; count++) {
externalType += JavaTypeConstants.ARRAY;
}
return externalType;
}
/**
* Converts an internal type into an external type, as expected by Class.forName.
*
* @param internalType the internal type, e.g. "Ljava/lang/Object;" or "
* [[Ljava/lang/Object;" or "[I".
* @return the external type, e.g. "java.lang.Object" or "[[Ljava.lang.Object;
* " or "[I".
*/
public static String externalClassForNameType(String internalType) {
return isInternalArrayType(internalType)
? externalClassName(internalType)
: externalClassName(internalClassNameFromClassType(internalType));
}
/**
* Returns whether the given internal descriptor String represents a method descriptor.
*
* @param internalDescriptor the internal descriptor String, e.g. "(II)Z".
* @return true if the given String is a method descriptor, false
* otherwise.
*/
public static boolean isInternalMethodDescriptor(String internalDescriptor) {
return internalDescriptor.charAt(0) == TypeConstants.METHOD_ARGUMENTS_OPEN;
}
/**
* Returns whether the given member String represents an external method name with arguments.
*
* @param externalMemberNameAndArguments the external member String, e.g. "myField"
* or e.g. "myMethod(int,int)".
* @return true if the given String refers to a method, false otherwise.
*/
public static boolean isExternalMethodNameAndArguments(String externalMemberNameAndArguments) {
return externalMemberNameAndArguments.indexOf(JavaTypeConstants.METHOD_ARGUMENTS_OPEN) > 0;
}
/**
* Returns the name part of the given external method name and arguments.
*
* @param externalMethodNameAndArguments the external method name and arguments, e.g. "
* myMethod(int,int)".
* @return the name part of the String, e.g. "myMethod".
*/
public static String externalMethodName(String externalMethodNameAndArguments) {
ExternalTypeEnumeration externalTypeEnumeration =
new ExternalTypeEnumeration(externalMethodNameAndArguments);
return externalTypeEnumeration.methodName();
}
/**
* Converts the given external method return type and name and arguments to an internal method
* descriptor.
*
* @param externalReturnType the external method return type, e.g. "boolean".
* @param externalMethodNameAndArguments the external method name and arguments, e.g. "
* myMethod(int,int)".
* @return the internal method descriptor, e.g. "(II)Z".
*/
public static String internalMethodDescriptor(
String externalReturnType, String externalMethodNameAndArguments) {
StringBuilder internalMethodDescriptor = new StringBuilder();
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_OPEN);
ExternalTypeEnumeration externalTypeEnumeration =
new ExternalTypeEnumeration(externalMethodNameAndArguments);
while (externalTypeEnumeration.hasMoreTypes()) {
internalMethodDescriptor.append(internalType(externalTypeEnumeration.nextType()));
}
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_CLOSE);
internalMethodDescriptor.append(internalType(externalReturnType));
return internalMethodDescriptor.toString();
}
/**
* Converts the given external method return type and List of arguments to an internal method
* descriptor.
*
* @param externalReturnType the external method return type, e.g. "boolean".
* @param externalArguments the external method arguments, e.g. { "int", "int" }.
* @return the internal method descriptor, e.g. "(II)Z".
*/
public static String internalMethodDescriptor(
String externalReturnType, List externalArguments) {
StringBuilder internalMethodDescriptor = new StringBuilder();
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_OPEN);
for (String externalArgument : externalArguments) {
internalMethodDescriptor.append(internalType(externalArgument));
}
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_CLOSE);
internalMethodDescriptor.append(internalType(externalReturnType));
return internalMethodDescriptor.toString();
}
/**
* Converts the given internal method return type and List of arguments to an internal method
* descriptor.
*
* @param internalReturnType the external method return type, e.g. "Z".
* @param internalArguments the external method arguments, e.g. { "I", "I" }.
* @return the internal method descriptor, e.g. "(II)Z".
*/
public static String internalMethodDescriptorFromInternalTypes(
String internalReturnType, List internalArguments) {
StringBuilder internalMethodDescriptor = new StringBuilder();
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_OPEN);
for (String argument : internalArguments) {
internalMethodDescriptor.append(argument);
}
internalMethodDescriptor.append(TypeConstants.METHOD_ARGUMENTS_CLOSE);
internalMethodDescriptor.append(internalReturnType);
return internalMethodDescriptor.toString();
}
/**
* Converts an internal field description into an external full field description.
*
* @param accessFlags the access flags of the field.
* @param fieldName the field name, e.g. "myField".
* @param internalFieldDescriptor the internal field descriptor, e.g. "Z".
* @return the external full field description, e.g. "public boolean myField".
*/
public static String externalFullFieldDescription(
int accessFlags, String fieldName, String internalFieldDescriptor) {
return externalFieldAccessFlags(accessFlags)
+ externalType(internalFieldDescriptor)
+ ' '
+ fieldName;
}
/**
* Converts an internal method description into an external full method description.
*
* @param internalClassName the internal name of the class of the method, e.g. "
* mypackage/MyClass".
* @param accessFlags the access flags of the method.
* @param internalMethodName the internal method name, e.g. "myMethod" or "
* <init>".
* @param internalMethodDescriptor the internal method descriptor, e.g. "(II)Z".
* @return the external full method description, e.g. "public boolean myMethod(int,int)
* " or "public MyClass(int,int)".
*/
public static String externalFullMethodDescription(
String internalClassName,
int accessFlags,
String internalMethodName,
String internalMethodDescriptor) {
return externalMethodAccessFlags(accessFlags)
+ externalMethodReturnTypeAndName(
internalClassName, internalMethodName, internalMethodDescriptor)
+ JavaTypeConstants.METHOD_ARGUMENTS_OPEN
+ externalMethodArguments(internalMethodDescriptor)
+ JavaTypeConstants.METHOD_ARGUMENTS_CLOSE;
}
/**
* Converts internal class access flags into an external access description.
*
* @param accessFlags the class access flags.
* @return the external class access description, e.g. "public final ".
*/
public static String externalClassAccessFlags(int accessFlags) {
return externalClassAccessFlags(accessFlags, "");
}
/**
* Converts internal class access flags into an external access description.
*
* @param accessFlags the class access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external class access description, e.g. "public final ".
*/
public static String externalClassAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.PUBLIC) != 0) {
string.append(prefix).append(JavaAccessConstants.PUBLIC).append(' ');
}
if ((accessFlags & AccessConstants.PRIVATE) != 0) {
// Only in InnerClasses attributes.
string.append(prefix).append(JavaAccessConstants.PRIVATE).append(' ');
}
if ((accessFlags & AccessConstants.PROTECTED) != 0) {
// Only in InnerClasses attributes.
string.append(prefix).append(JavaAccessConstants.PROTECTED).append(' ');
}
if ((accessFlags & AccessConstants.STATIC) != 0) {
// Only in InnerClasses attributes.
string.append(prefix).append(JavaAccessConstants.STATIC).append(' ');
}
if ((accessFlags & AccessConstants.FINAL) != 0) {
string.append(prefix).append(JavaAccessConstants.FINAL).append(' ');
}
if ((accessFlags & AccessConstants.ANNOTATION) != 0) {
string.append(prefix).append(JavaAccessConstants.ANNOTATION);
}
if ((accessFlags & AccessConstants.INTERFACE) != 0) {
string.append(prefix).append(JavaAccessConstants.INTERFACE).append(' ');
} else if ((accessFlags & AccessConstants.ENUM) != 0) {
string.append(prefix).append(JavaAccessConstants.ENUM).append(' ');
} else if ((accessFlags & AccessConstants.ABSTRACT) != 0) {
string.append(prefix).append(JavaAccessConstants.ABSTRACT).append(' ');
} else if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
} else if ((accessFlags & AccessConstants.MODULE) != 0) {
string.append(prefix).append(JavaAccessConstants.MODULE).append(' ');
}
return string.toString();
}
/**
* Converts internal field access flags into an external access description.
*
* @param accessFlags the field access flags.
* @return the external field access description, e.g. "public volatile ".
*/
public static String externalFieldAccessFlags(int accessFlags) {
return externalFieldAccessFlags(accessFlags, "");
}
/**
* Converts internal field access flags into an external access description.
*
* @param accessFlags the field access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external field access description, e.g. "public volatile ".
*/
public static String externalFieldAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.PUBLIC) != 0) {
string.append(prefix).append(JavaAccessConstants.PUBLIC).append(' ');
}
if ((accessFlags & AccessConstants.PRIVATE) != 0) {
string.append(prefix).append(JavaAccessConstants.PRIVATE).append(' ');
}
if ((accessFlags & AccessConstants.PROTECTED) != 0) {
string.append(prefix).append(JavaAccessConstants.PROTECTED).append(' ');
}
if ((accessFlags & AccessConstants.STATIC) != 0) {
string.append(prefix).append(JavaAccessConstants.STATIC).append(' ');
}
if ((accessFlags & AccessConstants.FINAL) != 0) {
string.append(prefix).append(JavaAccessConstants.FINAL).append(' ');
}
if ((accessFlags & AccessConstants.VOLATILE) != 0) {
string.append(prefix).append(JavaAccessConstants.VOLATILE).append(' ');
}
if ((accessFlags & AccessConstants.TRANSIENT) != 0) {
string.append(prefix).append(JavaAccessConstants.TRANSIENT).append(' ');
}
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
return string.toString();
}
/**
* Converts internal method access flags into an external access description.
*
* @param accessFlags the method access flags.
* @return the external method access description, e.g. "public synchronized ".
*/
public static String externalMethodAccessFlags(int accessFlags) {
return externalMethodAccessFlags(accessFlags, "");
}
/**
* Converts internal method access flags into an external access description.
*
* @param accessFlags the method access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external method access description, e.g. "public synchronized ".
*/
public static String externalMethodAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.PUBLIC) != 0) {
string.append(prefix).append(JavaAccessConstants.PUBLIC).append(' ');
}
if ((accessFlags & AccessConstants.PRIVATE) != 0) {
string.append(prefix).append(JavaAccessConstants.PRIVATE).append(' ');
}
if ((accessFlags & AccessConstants.PROTECTED) != 0) {
string.append(prefix).append(JavaAccessConstants.PROTECTED).append(' ');
}
if ((accessFlags & AccessConstants.STATIC) != 0) {
string.append(prefix).append(JavaAccessConstants.STATIC).append(' ');
}
if ((accessFlags & AccessConstants.FINAL) != 0) {
string.append(prefix).append(JavaAccessConstants.FINAL).append(' ');
}
if ((accessFlags & AccessConstants.SYNCHRONIZED) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNCHRONIZED).append(' ');
}
if ((accessFlags & AccessConstants.BRIDGE) != 0) {
string.append(prefix).append(JavaAccessConstants.BRIDGE).append(' ');
}
if ((accessFlags & AccessConstants.VARARGS) != 0) {
string.append(prefix).append(JavaAccessConstants.VARARGS).append(' ');
}
if ((accessFlags & AccessConstants.NATIVE) != 0) {
string.append(prefix).append(JavaAccessConstants.NATIVE).append(' ');
}
if ((accessFlags & AccessConstants.ABSTRACT) != 0) {
string.append(prefix).append(JavaAccessConstants.ABSTRACT).append(' ');
}
if ((accessFlags & AccessConstants.STRICT) != 0) {
string.append(prefix).append(JavaAccessConstants.STRICT).append(' ');
}
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
return string.toString();
}
/**
* Converts internal method parameter access flags into an external access description.
*
* @param accessFlags the method parameter access flags.
* @return the external method parameter access description, e.g. "final mandated ".
*/
public static String externalParameterAccessFlags(int accessFlags) {
return externalParameterAccessFlags(accessFlags, "");
}
/**
* Converts internal method parameter access flags into an external access description.
*
* @param accessFlags the method parameter access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external method parameter access description, e.g. "final mandated ".
*/
public static String externalParameterAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.FINAL) != 0) {
string.append(prefix).append(JavaAccessConstants.FINAL).append(' ');
}
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
if ((accessFlags & AccessConstants.MANDATED) != 0) {
string.append(prefix).append(JavaAccessConstants.MANDATED).append(' ');
}
return string.toString();
}
/**
* Converts an internal method descriptor into an external method return type.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(II)Z".
* @return the external method return type, e.g. "boolean".
*/
public static String externalMethodReturnType(String internalMethodDescriptor) {
return externalType(internalMethodReturnType(internalMethodDescriptor));
}
/**
* Converts internal module access flags into an external access description.
*
* @param accessFlags the module access flags.
* @return the external module access description, e.g. "open mandated ".
*/
public static String externalModuleAccessFlags(int accessFlags) {
return externalModuleAccessFlags(accessFlags, "");
}
/**
* Converts internal module access flags into an external access description.
*
* @param accessFlags the module access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external module access description, e.g. "final mandated ".
*/
public static String externalModuleAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.OPEN) != 0) {
string.append(prefix).append(JavaAccessConstants.OPEN).append(' ');
}
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
if ((accessFlags & AccessConstants.MANDATED) != 0) {
string.append(prefix).append(JavaAccessConstants.MANDATED).append(' ');
}
return string.toString();
}
/**
* Converts internal module requires access flags into an external access description.
*
* @param accessFlags the module requires access flags.
* @return the external module requires access description, e.g. "static mandated ".
*/
public static String externalRequiresAccessFlags(int accessFlags) {
return externalRequiresAccessFlags(accessFlags, "");
}
/**
* Converts internal module requires access flags into an external access description.
*
* @param accessFlags the module requires access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external module requires access description, e.g. "static mandated ".
*/
public static String externalRequiresAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.TRANSITIVE) != 0) {
string.append(prefix).append(JavaAccessConstants.TRANSITIVE).append(' ');
}
if ((accessFlags & AccessConstants.STATIC_PHASE) != 0) {
string.append(prefix).append(JavaAccessConstants.STATIC).append(' ');
}
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
if ((accessFlags & AccessConstants.MANDATED) != 0) {
string.append(prefix).append(JavaAccessConstants.MANDATED).append(' ');
}
return string.toString();
}
/**
* Converts internal module exports access flags into an external access description.
*
* @param accessFlags the module exports access flags.
* @return the external module exports access description, e.g. "synthetic mandated
* ".
*/
public static String externalExportsAccessFlags(int accessFlags) {
return externalExportsAccessFlags(accessFlags, "");
}
/**
* Converts internal module exports access flags into an external access description.
*
* @param accessFlags the module exports access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external module exports access description, e.g. "static mandated ".
*/
public static String externalExportsAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
if ((accessFlags & AccessConstants.MANDATED) != 0) {
string.append(prefix).append(JavaAccessConstants.MANDATED).append(' ');
}
return string.toString();
}
/**
* Converts internal module opens access flags into an external access description.
*
* @param accessFlags the module opens access flags.
* @return the external module opens access description, e.g. "synthetic mandated ".
*/
public static String externalOpensAccessFlags(int accessFlags) {
return externalOpensAccessFlags(accessFlags, "");
}
/**
* Converts internal module opens access flags into an external access description.
*
* @param accessFlags the module opens access flags.
* @param prefix a prefix that is added to each access modifier.
* @return the external module opens access description, e.g. "static mandated ".
*/
public static String externalOpensAccessFlags(int accessFlags, String prefix) {
if (accessFlags == 0) {
return EMPTY_STRING;
}
StringBuilder string = new StringBuilder(50);
if ((accessFlags & AccessConstants.SYNTHETIC) != 0) {
string.append(prefix).append(JavaAccessConstants.SYNTHETIC).append(' ');
}
if ((accessFlags & AccessConstants.MANDATED) != 0) {
string.append(prefix).append(JavaAccessConstants.MANDATED).append(' ');
}
return string.toString();
}
/**
* Converts an internal class name, method name, and method descriptor to an external method
* return type and name.
*
* @param internalClassName the internal name of the class of the method, e.g. "
* mypackage/MyClass".
* @param internalMethodName the internal method name, e.g. "myMethod" or "
* <init>".
* @param internalMethodDescriptor the internal method descriptor, e.g. "(II)Z".
* @return the external method return type and name, e.g. "boolean myMethod" or "
* MyClass".
*/
private static String externalMethodReturnTypeAndName(
String internalClassName, String internalMethodName, String internalMethodDescriptor) {
return internalMethodName.equals(ClassConstants.METHOD_NAME_INIT)
? externalShortClassName(externalClassName(internalClassName))
: (externalMethodReturnType(internalMethodDescriptor) + ' ' + internalMethodName);
}
/**
* Converts an internal method descriptor into an external method argument description.
*
* @param internalMethodDescriptor the internal method descriptor, e.g. "(II)Z".
* @return the external method argument description, e.g. "int,int".
*/
public static String externalMethodArguments(String internalMethodDescriptor) {
StringBuilder externalMethodNameAndArguments = new StringBuilder();
InternalTypeEnumeration internalTypeEnumeration =
new InternalTypeEnumeration(internalMethodDescriptor);
while (internalTypeEnumeration.hasMoreTypes()) {
externalMethodNameAndArguments.append(externalType(internalTypeEnumeration.nextType()));
if (internalTypeEnumeration.hasMoreTypes()) {
externalMethodNameAndArguments.append(JavaTypeConstants.METHOD_ARGUMENTS_SEPARATOR);
}
}
return externalMethodNameAndArguments.toString();
}
/**
* Returns the internal package name of the given internal class name.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return the internal package name, e.g. "java/lang".
*/
public static String internalPackageName(String internalClassName) {
String internalPackagePrefix = internalPackagePrefix(internalClassName);
int length = internalPackagePrefix.length();
return length > 0 ? internalPackagePrefix.substring(0, length - 1) : "";
}
/**
* Returns the internal package prefix of the given internal class name.
*
* @param internalClassName the internal class name, e.g. "java/lang/Object".
* @return the internal package prefix, e.g. "java/lang/".
*/
public static String internalPackagePrefix(String internalClassName) {
return internalClassName.substring(
0,
internalClassName.lastIndexOf(
TypeConstants.PACKAGE_SEPARATOR, internalClassName.length() - 2)
+ 1);
}
/**
* Returns the external package name of the given external class name.
*
* @param externalClassName the external class name, e.g. "java.lang.Object".
* @return the external package name, e.g. "java.lang".
*/
public static String externalPackageName(String externalClassName) {
String externalPackagePrefix = externalPackagePrefix(externalClassName);
int length = externalPackagePrefix.length();
return length > 0 ? externalPackagePrefix.substring(0, length - 1) : "";
}
/**
* Returns the external package prefix of the given external class name.
*
* @param externalClassName the external class name, e.g. "java.lang.Object".
* @return the external package prefix, e.g. "java.lang.".
*/
public static String externalPackagePrefix(String externalClassName) {
return externalClassName.substring(
0,
externalClassName.lastIndexOf(
JavaTypeConstants.PACKAGE_SEPARATOR, externalClassName.length() - 2)
+ 1);
}
/**
* Returns `true` if a {@link Clazz} is null or if it does not represent a final class. This means
* that for the sake of our analysis we can consider value of this class not extendable.
*/
public static boolean isExtendable(Clazz clazz) {
return clazz == null || (clazz.getAccessFlags() & FINAL) == 0;
}
}