/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.bcel.util;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
import org.apache.bcel.Const;
import org.apache.bcel.classfile.Constant;
import org.apache.bcel.classfile.ConstantClass;
import org.apache.bcel.classfile.ConstantFieldref;
import org.apache.bcel.classfile.ConstantInterfaceMethodref;
import org.apache.bcel.classfile.ConstantMethodref;
import org.apache.bcel.classfile.ConstantNameAndType;
import org.apache.bcel.classfile.ConstantPool;
import org.apache.bcel.classfile.ConstantString;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Utility;
/**
* Convert constant pool into HTML file.
*
* @version $Id$
*
*/
final class ConstantHTML {
private final String class_name; // name of current class
private final String class_package; // name of package
private final ConstantPool constant_pool; // reference to constant pool
private final PrintWriter file; // file to write to
private final String[] constant_ref; // String to return for cp[i]
private final Constant[] constants; // The constants in the cp
private final Method[] methods;
ConstantHTML(final String dir, final String class_name, final String class_package, final Method[] methods,
final ConstantPool constant_pool) throws IOException {
this.class_name = class_name;
this.class_package = class_package;
this.constant_pool = constant_pool;
this.methods = methods;
constants = constant_pool.getConstantPool();
file = new PrintWriter(new FileOutputStream(dir + class_name + "_cp.html"));
constant_ref = new String[constants.length];
constant_ref[0] = "<unknown>";
file.println("");
// Loop through constants, constants[0] is reserved
for (int i = 1; i < constants.length; i++) {
if (i % 2 == 0) {
file.print("| ");
} else {
file.print(" |
| ");
}
if (constants[i] != null) {
writeConstant(i);
}
file.print(" |
\n");
}
file.println("
");
file.close();
}
String referenceConstant( final int index ) {
return constant_ref[index];
}
private void writeConstant( final int index ) {
final byte tag = constants[index].getTag();
int class_index;
int name_index;
String ref;
// The header is always the same
file.println(" " + index + " " + Const.getConstantName(tag)
+ "
");
/* For every constant type get the needed parameters and print them appropiately
*/
switch (tag) {
case Const.CONSTANT_InterfaceMethodref:
case Const.CONSTANT_Methodref:
// Get class_index and name_and_type_index, depending on type
if (tag == Const.CONSTANT_Methodref) {
final ConstantMethodref c = (ConstantMethodref) constant_pool.getConstant(index,
Const.CONSTANT_Methodref);
class_index = c.getClassIndex();
name_index = c.getNameAndTypeIndex();
} else {
final ConstantInterfaceMethodref c1 = (ConstantInterfaceMethodref) constant_pool
.getConstant(index, Const.CONSTANT_InterfaceMethodref);
class_index = c1.getClassIndex();
name_index = c1.getNameAndTypeIndex();
}
// Get method name and its class
final String method_name = constant_pool.constantToString(name_index,
Const.CONSTANT_NameAndType);
final String html_method_name = Class2HTML.toHTML(method_name);
// Partially compacted class name, i.e., / -> .
final String method_class = constant_pool.constantToString(class_index, Const.CONSTANT_Class);
String short_method_class = Utility.compactClassName(method_class); // I.e., remove java.lang.
short_method_class = Utility.compactClassName(short_method_class, class_package
+ ".", true); // Remove class package prefix
// Get method signature
final ConstantNameAndType c2 = (ConstantNameAndType) constant_pool.getConstant(
name_index, Const.CONSTANT_NameAndType);
final String signature = constant_pool.constantToString(c2.getSignatureIndex(),
Const.CONSTANT_Utf8);
// Get array of strings containing the argument types
final String[] args = Utility.methodSignatureArgumentTypes(signature, false);
// Get return type string
final String type = Utility.methodSignatureReturnType(signature, false);
final String ret_type = Class2HTML.referenceType(type);
final StringBuilder buf = new StringBuilder("(");
for (int i = 0; i < args.length; i++) {
buf.append(Class2HTML.referenceType(args[i]));
if (i < args.length - 1) {
buf.append(", ");
}
}
buf.append(")");
final String arg_types = buf.toString();
if (method_class.equals(class_name)) {
ref = ""
+ html_method_name + "";
} else {
ref = ""
+ short_method_class + "." + html_method_name;
}
constant_ref[index] = ret_type + " " + short_method_class
+ "." + html_method_name + " " + arg_types;
file.println("" + ret_type + " " + ref + arg_types
+ " \n
");
break;
case Const.CONSTANT_Fieldref:
// Get class_index and name_and_type_index
final ConstantFieldref c3 = (ConstantFieldref) constant_pool.getConstant(index,
Const.CONSTANT_Fieldref);
class_index = c3.getClassIndex();
name_index = c3.getNameAndTypeIndex();
// Get method name and its class (compacted)
final String field_class = constant_pool.constantToString(class_index, Const.CONSTANT_Class);
String short_field_class = Utility.compactClassName(field_class); // I.e., remove java.lang.
short_field_class = Utility.compactClassName(short_field_class,
class_package + ".", true); // Remove class package prefix
final String field_name = constant_pool
.constantToString(name_index, Const.CONSTANT_NameAndType);
if (field_class.equals(class_name)) {
ref = "" + field_name + "";
} else {
ref = "" + short_field_class
+ "." + field_name + "\n";
}
constant_ref[index] = "" + short_field_class + "."
+ field_name + "";
file.println("" + ref + "
\n" + "
");
break;
case Const.CONSTANT_Class:
final ConstantClass c4 = (ConstantClass) constant_pool.getConstant(index, Const.CONSTANT_Class);
name_index = c4.getNameIndex();
final String class_name2 = constant_pool.constantToString(index, tag); // / -> .
String short_class_name = Utility.compactClassName(class_name2); // I.e., remove java.lang.
short_class_name = Utility.compactClassName(short_class_name, class_package + ".",
true); // Remove class package prefix
ref = "" + short_class_name
+ "";
constant_ref[index] = "" + short_class_name + "";
file.println("" + ref + "
\n");
break;
case Const.CONSTANT_String:
final ConstantString c5 = (ConstantString) constant_pool.getConstant(index,
Const.CONSTANT_String);
name_index = c5.getStringIndex();
final String str = Class2HTML.toHTML(constant_pool.constantToString(index, tag));
file.println("" + str + "
\n");
break;
case Const.CONSTANT_NameAndType:
final ConstantNameAndType c6 = (ConstantNameAndType) constant_pool.getConstant(index,
Const.CONSTANT_NameAndType);
name_index = c6.getNameIndex();
final int signature_index = c6.getSignatureIndex();
file.println(""
+ Class2HTML.toHTML(constant_pool.constantToString(index, tag))
+ "
\n");
break;
default:
file.println("" + Class2HTML.toHTML(constant_pool.constantToString(index, tag)) + "\n");
} // switch
}
private int getMethodNumber( final String str ) {
for (int i = 0; i < methods.length; i++) {
final String cmp = methods[i].getName() + methods[i].getSignature();
if (cmp.equals(str)) {
return i;
}
}
return -1;
}
}