/*
* 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.Attribute;
import org.apache.bcel.classfile.Code;
import org.apache.bcel.classfile.ConstantValue;
import org.apache.bcel.classfile.ExceptionTable;
import org.apache.bcel.classfile.Field;
import org.apache.bcel.classfile.Method;
import org.apache.bcel.classfile.Utility;
/**
* Convert methods and fields into HTML file.
*
* @version $Id$
*
*/
final class MethodHTML {
private final String class_name; // name of current class
private final PrintWriter file; // file to write to
private final ConstantHTML constant_html;
private final AttributeHTML attribute_html;
MethodHTML(final String dir, final String class_name, final Method[] methods, final Field[] fields,
final ConstantHTML constant_html, final AttributeHTML attribute_html) throws IOException {
this.class_name = class_name;
this.attribute_html = attribute_html;
this.constant_html = constant_html;
file = new PrintWriter(new FileOutputStream(dir + class_name + "_methods.html"));
file.println("");
file.println("| Access flags | Type | "
+ "Field name |
|---|
");
for (final Field field : fields) {
writeField(field);
}
file.println("
");
file.println("| Access flags | "
+ "Return type | Method name | "
+ "Arguments |
|---|
");
for (int i = 0; i < methods.length; i++) {
writeMethod(methods[i], i);
}
file.println("
");
file.close();
}
/**
* Print field of class.
*
* @param field field to print
* @throws java.io.IOException
*/
private void writeField( final Field field ) throws IOException {
final String type = Utility.signatureToString(field.getSignature());
final String name = field.getName();
String access = Utility.accessToString(field.getAccessFlags());
Attribute[] attributes;
access = Utility.replace(access, " ", " ");
file.print("| " + access + " | \n"
+ Class2HTML.referenceType(type) + " | " + name
+ " | ");
attributes = field.getAttributes();
// Write them to the Attributes.html file with anchor "[]"
for (int i = 0; i < attributes.length; i++) {
attribute_html.writeAttribute(attributes[i], name + "@" + i);
}
for (int i = 0; i < attributes.length; i++) {
if (attributes[i].getTag() == Const.ATTR_CONSTANT_VALUE) { // Default value
final String str = ((ConstantValue) attributes[i]).toString();
// Reference attribute in _attributes.html
file.print("= " + str + " | \n");
break;
}
}
file.println("
");
}
private void writeMethod( final Method method, final int method_number ) {
// Get raw signature
final String signature = method.getSignature();
// 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);
// Get method name
final String name = method.getName();
String html_name;
// Get method's access flags
String access = Utility.accessToString(method.getAccessFlags());
// Get the method's attributes, the Code Attribute in particular
final Attribute[] attributes = method.getAttributes();
/* HTML doesn't like names like and spaces are places to break
* lines. Both we don't want...
*/
access = Utility.replace(access, " ", " ");
html_name = Class2HTML.toHTML(name);
file.print("| " + access + " | ");
file.print("" + Class2HTML.referenceType(type) + " | " + "" + html_name
+ " | \n(");
for (int i = 0; i < args.length; i++) {
file.print(Class2HTML.referenceType(args[i]));
if (i < args.length - 1) {
file.print(", ");
}
}
file.print(") |
");
// Check for thrown exceptions
for (int i = 0; i < attributes.length; i++) {
attribute_html.writeAttribute(attributes[i], "method" + method_number + "@" + i,
method_number);
final byte tag = attributes[i].getTag();
if (tag == Const.ATTR_EXCEPTIONS) {
file.print(" | throws | ");
final int[] exceptions = ((ExceptionTable) attributes[i]).getExceptionIndexTable();
for (int j = 0; j < exceptions.length; j++) {
file.print(constant_html.referenceConstant(exceptions[j]));
if (j < exceptions.length - 1) {
file.print(", ");
}
}
file.println(" |
|---|
");
} else if (tag == Const.ATTR_CODE) {
final Attribute[] c_a = ((Code) attributes[i]).getAttributes();
for (int j = 0; j < c_a.length; j++) {
attribute_html.writeAttribute(c_a[j], "method" + method_number + "@" + i + "@"
+ j, method_number);
}
}
}
}
}